Skip to main content
GET
/
api
/
v1
/
provider_connections
Lists provider connection status summaries
curl --request GET \
  --url https://app.sure.am/api/v1/provider_connections \
  --header 'X-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "provider": "<string>",
      "provider_type": "<string>",
      "name": "<string>",
      "status": "<string>",
      "requires_update": true,
      "credentials_configured": true,
      "scheduled_for_deletion": true,
      "pending_account_setup": true,
      "institution": {
        "name": "<string>",
        "domain": "<string>",
        "url": "<string>"
      },
      "accounts": {
        "total_count": 1,
        "linked_count": 1,
        "unlinked_count": 1
      },
      "sync": {
        "syncing": true,
        "status_summary": "<string>",
        "last_synced_at": "2023-11-07T05:31:56Z",
        "latest": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "status": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "syncing_at": "2023-11-07T05:31:56Z",
          "completed_at": "2023-11-07T05:31:56Z",
          "failed_at": "2023-11-07T05:31:56Z",
          "error": {
            "present": true,
            "message": "<string>"
          }
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.sure.am/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Response

provider connection status summaries listed

data
object[]
required