Retrieve a list of integrations

GET 
/api/v1/integrations

Get a paginated list of all available integrations.

To configure available integrations, refer to the manage integrations guide.

Request

Query Parameters

page integer

Possible values: >= 1

Default value: 1

The page number to retrieve.

quantity integer

Possible values: >= 1 and <= 100

Default value: 20

The number of items to retrieve per page.

Responses

200

A list of integrations.

application/json

Schema

Schema

data object[]
The list of integrations.
Array [
name stringrequired
The name of the integration.
id stringrequired
The unique identifier of the integration.
url stringrequired
The URL associated with the integration.
status stringrequired
Possible values: [active, disabled]
The current status of the integration.
• active: The integration is active and ready to use.
• disabled: The integration is disabled and cannot be used to create orders.
To change the status of the integration, refer to the instructions in the manage integrations guide.
]
pagination object

quantity integerrequired

The number of items per page.

totalQuantity integerrequired

The total number of items available.

currentPage integerrequired

The current page number.

pages integerrequired

The total number of pages available.

Example (from schema)

{
  "data": [
    {
      "name": "test",
      "id": "1ef65bda-11ad-63ca-8afe-73770edda314",
      "url": "https://example.com",
      "status": "active"
    }
  ],
  "pagination": {
    "quantity": 1,
    "totalQuantity": 1,
    "currentPage": 1,
    "pages": 1
  }
}

Loading...