Skip to main content
GET
/
contracts
/
schemas
Retrieve a list of contract schemas
curl --request GET \
  --url https://panel.sendcloud.sc/api/v3/contracts/schemas \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "carrier_code": "ups",
      "fields": [
        {
          "name": "account_number",
          "description": "Your UPS Account Manager can provide you with the Account Number.",
          "required": true,
          "type": "string"
        },
        {
          "name": "country",
          "description": "Select a contract country.",
          "required": false,
          "type": "choice",
          "choices": [
            {
              "code": "NL",
              "description": "Netherlands"
            },
            {
              "code": "BE",
              "description": "Belgium"
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
carrier_code
string

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

Response

OK

Retrieve contract schemas.

​
data
Contract schema · object[]
required