SCscalekit
Connected Accounts

Search connected accounts

Changed on

Search for connected accounts in your environment using a text query that matches against identifiers, providers, or connectors. The search performs case-insensitive matching across account details. Returns paginated results with account status and authentication type information.

get/api/v1/connected_accounts:search

Request

Query parameters

querystring

Search term to match against connected account identifiers, providers, or connectors. Must be at least 3 characters. Case insensitive.

page_sizeinteger

Maximum number of connected accounts to return per page. Value must be between 1 and 30.

page_tokenstring

Token from a previous response for pagination. Provide this to retrieve the next page of results.

connection_idstring

Connection ID to filter connected accounts

Response

Successfully retrieved matching connected accounts with pagination support

next_page_tokenstring

Pagination token for the next page. Empty if this is the last page.

prev_page_tokenstring

Pagination token for the previous page. Empty if this is the first page.

total_sizeinteger

Total count of accounts matching the search query across all pages.

Example response

{
  "connected_accounts": [
    {
      "connection_id": "conn_24834495392086178",
      "connector": "notion",
      "id": "ca_24834495392086178",
      "identifier": "user@example.com",
      "last_used_at": "2024-03-20T14:30:00Z",
      "provider": "GMAIL",
      "token_expires_at": "2024-12-31T23:59:59Z",
      "updated_at": "2024-03-20T15:04:05Z"
    }
  ],
  "next_page_token": "eyJvZmZzZXQiOjMwfQ==",
  "prev_page_token": "eyJvZmZzZXQiOjB9",
  "total_size": 100
}

Changes

  • 8895edb68754Revision changes
    • info

      added the optional property // to the response with the status

  • a0c0427afd17Revision changes
    • warning

      added the new NO_AUTH enum value to the // response property for the response status