Skip to main content
GET
/
api
/
v2
/
oauth
/
session
/
status
/
{sessionId}
Get oauth session status
curl --request GET \
  --url https://api.instantly.ai/api/v2/oauth/session/status/{sessionId} \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "email": "user@example.com",
  "name": "John Doe",
  "error": "access_denied",
  "error_description": "User denied access to the application"
}

Documentation Index

Fetch the complete documentation index at: https://developer.instantly.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
sessionId
string
required

Session ID from init response

Example:

"abc123def456"

Response

200 - application/json

Default Response

​
status
enum<string>

Current status of the OAuth session

Available options:
pending,
success,
error,
expired
Example:

"success"

​
email
string

Email of the connected account (on success)

Example:

"user@example.com"

​
name
string

Name of the account owner (on success)

Example:

"John Doe"

​
error
string

Error code (on error)

Example:

"access_denied"

​
error_description
string

Human-readable error description (on error)

Example:

"User denied access to the application"