Skip to main content

ConnectedAccountsResponse

Response schema for multiple connected accounts

data object[]required

A list of connected accounts

  • Array [
  • connection_scopestringrequired

    The scope of this connection. 'user' means owned by a specific user, 'account' means shared across the account.

    Possible values: [user, account]

    created_atstring<date-time>required

    Time at which the object was created.

    display_namestringnullablerequired

    The display name from the provider.

    emailstringrequired

    The email address associated with this connected account.

    external_subjectstringrequired

    The unique identifier for this account at the provider.

    idstringrequired

    Unique identifier for the object.

    Possible values: Value must match regular expression ^cact_\w{12}$

    objectstringrequired

    String representing the object's type.

    Possible values: [connected_account]

    providerstringrequired

    The calendar provider for this connected account.

    Possible values: [google]

    statusstringrequired

    The current status of the connection. 'active' means the connection is working, 'reconnect_required' means the OAuth token has failed and needs reauthorization, 'insufficient_permissions' means the user did not grant all required OAuth scopes.

    Possible values: [active, reconnect_required, insufficient_permissions]

    updated_atstring<date-time>required

    Time at which the object was last updated.

    user_idstringnullablerequired

    The ID of the user who owns this connected account.

  • ]
  • meta objectrequired

    Metadata for paginated responses

    current_pageintegerrequired

    Current page number

    page_sizeintegerrequired

    Number of records per page

    total_countintegerrequired

    Total number of records

    total_pagesintegerrequired

    Total number of pages

    ConnectedAccountsResponse
    {
    "data": [
    {
    "connection_scope": "user",
    "created_at": "2025-03-12T12:34:55Z",
    "display_name": "John Doe",
    "email": "user@example.com",
    "external_subject": "123456789",
    "id": "cact_d025a96ac0c6",
    "object": "connected_account",
    "provider": "google",
    "status": "active",
    "updated_at": "2025-03-13T10:11:12Z",
    "user_id": "user_d025a96ac0c6"
    }
    ],
    "meta": {
    "current_page": 1,
    "page_size": 10,
    "total_count": 50,
    "total_pages": 5
    }
    }