Skip to main content
GET
/
contracts
Retrieve a list of contracts
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/contracts \
  --header 'Authorization: Basic <encoded-value>'
{
  "next": null,
  "previous": null,
  "contracts": [
    {
      "id": 60,
      "carrier": {
        "code": "lettresuivie",
        "name": "Lettre Suivie"
      },
      "client_id": "sendcloud-1",
      "is_active": true,
      "country": "FR",
      "is_default": true
    },
    {
      "id": 61,
      "carrier": {
        "code": "poste_italiane",
        "name": "Poste Italiane"
      },
      "client_id": "sendcloud-1",
      "is_active": true,
      "country": "IT",
      "is_default": true
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

carrier
string

The carrier you want to filter for, for instance: postnl. You can find available carriers in your Sendcloud account settings.

is_active
boolean

Filter contracts based on the status.

client_id
string

Filter direct contracts based on the client id.

name
string

Filter direct contracts based on the contract's name.

country
string

Filter contracts based on the country of the contract, it should be in the ISO 3166-1 alpha-2 format.

Response

200 - application/json

OK

contracts
Contract · object[]
required
next
string | null

Url to retrieve the next page of contracts.

previous
string | null

Url to retrieve the previous page of contracts.