Skip to main content
GET
/
v1
/
connections
Get Connections
curl --request GET \
  --url https://api.example.com/v1/connections \
  --header 'X-API-KEY: <api-key>' \
  --header 'x-organization-id: <x-organization-id>'
{
  "items": [
    {
      "id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "last_synced": "2023-11-07T05:31:56Z",
      "source": "BIGCOMMERCE",
      "external_id": "<string>",
      "status": "ACTIVE",
      "records_synced": 123,
      "store_name": "<string>",
      "initial_import_complete": false,
      "url": "<string>",
      "tax_calculation_ready": false,
      "tax_calculation_enabled": false,
      "needs_update": false,
      "vertex_enabled": false,
      "default_country": "AF",
      "marketplace_id": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-organization-id
string | null
required

The unique identifier for the organization making the request

Query Parameters

​
status
string
default:""
​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Successful Response

​
items
ConnectionRead · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1
​
pages
integer
required
Required range: x >= 0