Sign in
assistants

Changed on

List all OAuth connections for the current user on an assistant.

Returns connection state (active/expired/revoked/error) and account label for each connected provider credential.

Supports both session auth (webapp) and assistant API key auth (CLI/daemon).

get/v1/assistants/{assistant_id}/oauth/connections/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token

Path parameters

assistant_idstring uuid required

Query parameters

account_identifierstring

Filter connections by provider account ID.

provider'airtable' | 'asana' | 'calendly' | 'discord' | 'dropbox' | 'eventbrite' | 'figma' | 'github' | 'google' | 'hubspot' | 'linear' | 'monday' | 'notion' | 'outlook' | 'quickbooks' | 'salesforce' | 'shopify' | 'stripe_link' | 'todoist' | 'twitter'

Filter connections by OAuth provider.

status'ACTIVE' | 'ALL' | 'ERROR' | 'REVOKED'

Filter by connection status. Defaults to ACTIVE. Use ALL to return all statuses.

Response

idstring uuid required
provider'twitter' | 'google' | 'outlook' | 'linear' | 'github' | 'asana' | 'notion' | 'todoist' | 'dropbox' | 'discord' | 'airtable' | 'hubspot' | 'salesforce' | 'eventbrite' | 'calendly' | 'monday' | 'figma' | 'stripe_link' | 'shopify' | 'quickbooks' required
  • twitter - twitter
  • google - google
  • outlook - outlook
  • linear - linear
  • github - github
  • asana - asana
  • notion - notion
  • todoist - todoist
  • dropbox - dropbox
  • discord - discord
  • airtable - airtable
  • hubspot - hubspot
  • salesforce - salesforce
  • eventbrite - eventbrite
  • calendly - calendly
  • monday - monday
  • figma - figma
  • stripe_link - stripe_link
  • shopify - shopify
  • quickbooks - quickbooks
status'ACTIVE' | 'REVOKED' | 'ERROR' required
  • ACTIVE - Active
  • REVOKED - Revoked
  • ERROR - Error
connectedboolean required
account_labelstring nullable required
scopes_grantedstring[] required
expires_atstring date-time nullable required
provider_paramsobject

Changes

  • a5a0e9261a3fRevision changes
    • ●

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

    • ●

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

    • ○

      added the new enum value quickbooks to the query request parameter provider

    • ○

      added the new enum value shopify to the query request parameter provider

    • ○

      added the optional property / to the response with the status

  • 28343fee3a3bRevision changes
    • ●

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

    • ○

      added the new enum value stripe_link to the query request parameter provider