Get OAuth config status

Retrieves the current status of an OAuth configuration. Shows whether the OAuth flow is pending, authorized, or failed, and includes token expiration and scopes if authorized.

GET /api/oauth/config/{id}/status

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "token_id": "<string>",
  "token_expires_at": "2023-11-07T05:31:56Z",
  "token_scopes": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Path Parameters

id · string · required

OAuth config ID

Response

200

application/json

OAuth config status retrieved successfully

Status of an OAuth configuration

id · string

OAuth config ID

status · enum<string>

Current status of the OAuth flow:

• pending: User has not yet authorized
• authorized: User authorized and token is stored
• failed: Authorization failed

Available options: pending, authorized, failed

created_at · string<date-time>

When this OAuth config was created

expires_at · string<date-time>

When this OAuth config expires (becomes invalid if not completed)

token_id · string

ID of the associated OAuth token (only present if status is authorized)

token_expires_at · string<date-time>

When the OAuth access token expires (only present if status is authorized)

token_scopes · string[]

Scopes granted in the OAuth token (only present if status is authorized)