Sign in

Get connector connection status

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns where a connector authorization you started with Start connector connection stands. Poll it every few seconds after opening the link, until status is ACTIVE or FAILED.

An authorization nobody completes stays PENDING, so stop polling a few minutes after the link expires. A connection another collaborator started always reads as PENDING to you.

This is limited to 70 requests a minute per caller. Some workspaces have a different limit.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app, including a read-only key. Workspace API keys are not accepted.</Note>

get/api/apps/{app_id}/external-auth/status

Path parameters

app_idstring required

ID of the app.

ID of the app.

Query parameters

'googlecalendar' | 'google_classroom' | 'googledrive' | 'gmail' | 'googlesheets' | 'googledocs' | 'googleslides' | 'googlebigquery' | 'googlemeet' | 'googletasks' | 'googleads' | 'google_analytics' | 'google_search_console' | 'slack' | 'notion' | 'salesforce' | 'hubspot' | 'linkedin' | 'tiktok' | 'instagram' | 'discord' | 'slackbot' | 'wix' | 'github' | 'gitlab' | 'bamboohr' | 'dropbox' | 'clickup' | 'wrike' | 'box' | 'outlook' | 'linear' | 'airtable' | 'microsoft_teams' | 'share_point' | 'one_drive' | 'typeform' | 'splitwise' | 'hugging_face' | 'calendly' | 'contentful' | 'supabase' | 'snowflake' | 'databricks' | 'quickbooks' | 'square' required
OR
string required

Connector the authorization is for.

connection_idstring required

connection_id returned by Start connector connection.

connection_id returned by Start connector connection.

Response

Where the authorization stands.

status'ACTIVE' | 'FAILED' | 'PENDING' required

Enum for integration polling statuses.

status_reasonstring nullable

Why the authorization failed, when status is FAILED and you started it. The value is null otherwise.

Example response

{
  "status_reason": "OAuth provider returned access_denied"
}

Changes

Changed in 1 of the 34 revisions of this API.1