Skip to main content
GET
/
integrations
Retrieve a list of integrations
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/integrations \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": 23452345,
      "shop_name": "Integration #1",
      "shop_url": "https://www.my-shop-integration.com/",
      "type": "api",
      "started_failing_at": "2023-11-10T16:16:42Z",
      "last_fetched_at": "2023-11-10T16:15:09Z",
      "created_at": "2023-11-04T14:15:22Z",
      "updated_at": "2023-11-08T12:23:56Z",
      "service_point_enabled": true,
      "service_point_carriers": [
        "ups",
        "dhl"
      ],
      "webhook_active": true,
      "webhook_url": "https://my-shop-integration.integrator/api/webhooks/sendcloud",
      "feedback_type": "eager"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

​
sort
string

Set the order for the response items:

  • Sorting is supported by the integration_type, created_at, updated_at, last_fetch, and failing_since attributes in the response object.
  • To sort the response in descending order, add the prefix - to the query param value.
  • By default, the items will be ordered by last_fetch and then created_at.

Response

200 - application/json

All valid integrations from the Sendcloud System for a given user.

Integration object as represented in the response of the list request.

​
data
Integration Response Object · object[]