Connected Accounts

List connected accounts with optional filters

Retrieves all connected accounts for your project. Connected accounts represent authenticated user connections to external services (e.g., a user's Gmail account, Slack workspace). Filter by toolkit, status, user ID, or auth config to find specific connections.

get/api/v3.1/connected_accounts

Query parameters

toolkit_slugsstring[] nullable

The toolkit slugs of the connected accounts

The toolkit slugs of the connected accounts

statusesstring[] nullable

The status of the connected account

The status of the connected account

cursorstring nullable

The cursor to paginate through the connected accounts

The cursor to paginate through the connected accounts

limitnumber nullable

The limit of the connected accounts to return

The limit of the connected accounts to return

user_idsstring[] nullable

The user ids of the connected accounts

The user ids of the connected accounts

auth_config_idsstring[] nullable

The auth config ids of the connected accounts

The auth config ids of the connected accounts

connected_account_idsstring[] nullable

The connected account ids to filter by

The connected account ids to filter by

order_by'created_at' | 'updated_at'

The order by of the connected accounts

The order by of the connected accounts

order_direction'asc' | 'desc'

The order direction of the connected accounts

The order direction of the connected accounts

account_type'PRIVATE' | 'SHARED' | 'ALL'

[Experimental] Filter by sharing model. Default (omitted) returns PRIVATE only — shared accounts must be requested explicitly. Pass SHARED for only shared accounts, or ALL for PRIVATE + SHARED.

[Experimental] Filter by sharing model. Default (omitted) returns PRIVATE only — shared accounts must be requested explicitly. Pass SHARED for only shared accounts, or ALL for PRIVATE + SHARED.

Response

Successfully retrieved connected accounts

next_cursorstring nullable
total_pagesnumber required
current_pagenumber required
total_itemsnumber required

Changes

Changed in 8 of the 61 revisions of this API.449

    • removed the optional property items/items/auth_config/deprecated from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/items/deprecated from the response with the 200 status

      response-optional-property-removed

  • ad121cf38fe011See the full diff
    • added subschema #3 subschema #4 to the items/items/state/oneOf[subschema #14]/val response property oneOf list for the response status 200

      response-property-one-of-added

    • removed subschema #3 subschema #4 from the items/items/state/oneOf[subschema #14]/val response property oneOf list for the response status 200

      response-property-one-of-removed

    • the endpoint scheme security CookieAuth was removed from the API

      api-security-removed

  • 166dca8a495b111See the full diff
    • removed the required property items/items/account_type from the response with the 200 status

      response-required-property-removed

    • removed the optional property items/items/acl_config_for_shared from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/items/experimental to the response with the 200 status

      response-optional-property-added

  • 23348819b35e12See the full diff
    • added subschema #3 subschema #4 to the items/items/state/oneOf[subschema #2]/val response property oneOf list for the response status 200

      response-property-one-of-added

    • added the optional property items/items/acl_config_for_shared to the response with the 200 status

      response-optional-property-added

    • removed subschema #3 subschema #4 from the items/items/state/oneOf[subschema #2]/val response property oneOf list for the response status 200

      response-property-one-of-removed

    • added the new optional query request parameter account_type

      new-optional-request-parameter

    • added the required property items/items/account_type to the response with the 200 status

      response-required-property-added

  • 5a3709be76a7111See the full diff
    • added subschema #7 to the items/items/state/oneOf[subschema #2]/val response property oneOf list for the response status 200

      response-property-one-of-added

    • added the new REVOKED enum value to the items/items/status response property for the response status 200

      response-property-enum-value-added

    • added the enum value REVOKED to the property items/ of the query request parameter statuses

      request-parameter-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added