Integrations

Get connection status

Changed on

Polls the status of an in-progress OAuth connection. The connect_id is returned by the Start OAuth Connection endpoint. Poll this endpoint until the status changes from "pending" to "connected". The connect_id expires after 10 minutes.

get/v1/integrations/connect/{connect_id}/status

Request

  • Base URL
    https://app.nex.ai/api/developers
  • Auth
    API key in header Authorization

Path parameters

connect_idstring required

Connect ID returned by the start connect endpoint

Response

Current connection status

status'pending' | 'connected'

Connection status: "pending" while waiting, "connected" when complete

connection_idinteger

ID of the newly created connection (only present when status is "connected")

Example response

{
  "status": "connected",
  "connection_id": 12345
}

Changes