Skip to main content
GET
/
connections
Get Connections
curl --request GET \
  --url https://api.example.com/connections \
  --header 'x-api-key: <x-api-key>'
{
  "connections": [
    {
      "connection_id": "<string>",
      "customer_id": "<string>",
      "retailer_id": "<string>",
      "status": "active",
      "email": "alice@example.com",
      "mobile": "+1234567890"
    }
  ]
}

Headers

x-api-key
string
required

The client's API key secret value

Query Parameters

customer_id
string
required

The customer id to filter connections by

Response

Successful Response

connections
ConnectionResponse · object[]
required

List of connections