Skip to main content
GET
Get Connection

Headers

authorization
string | null
x-api-key
string | null

Path Parameters

connection_id
string
required

A unique identifier for the connection

Response

Successful Response

connection_id
string
required

A unique identifier for the connection

Example:

"01J51S0JYV6N7K1030CV1ZKSCA"

customer_id
string
required

A unique identifier used to map connections to customer records in external systems.

Example:

"8a46e581-48ba-498a-9ad0-2ee72582e1af"

retailer_id
string
required

The unique identifier for the retailer in the connection

Example:

"01J7SC0NN73R6F5VVSP3ZKPDA3"

status
enum<string>
required

The status of the connection

Available options:
active,
initialized,
unauthenticated,
disconnected
Example:

"active"

email
string | null
required

The customer's email address

mobile
string | null
required

The customer's mobile phone number

Example:

"+1234567890"

tags
Tags · object

Client-defined attribution tags recorded when the connection is created, for grouping connection metrics — e.g. {"campaign": "summer_sweeps", "program": "loyalty"}. Names and values are opaque to Subtotal and are never interpreted. At most 10 tags; names up to 64 characters, values up to 256. Intended for campaign and source metadata — do not put consumer PII in tags.

Example: