Skip to main content
GET
/
connection
/
{connection_id}
{
  "status": "active",
  "retailer_id": "01J7SC0NN73R6F5VVSP3ZKPDA3"
}

Authorizations

​
Authorization
string
header
required

A connection-specific token with access scope

Headers

​
x-api-key
string
required

The client's API key secret value

Path Parameters

​
connection_id
string
required

Response

Successful Response

​
status
enum<string>
required

The status of the connection

Available options:
active,
blocked,
initialized,
needs_otp_method,
needs_otp,
failed_auth,
started,
attempted,
exited,
unauthenticated
​
retailer_id
string
required

The identifier of the retailer that is connected

Examples:

"01J7SC0NN73R6F5VVSP3ZKPDA3"

⌘I