Skip to main content
GET
/
contracts
/
{id}
Retrieve a contract
curl --request GET \
  --url https://panel.sendcloud.sc/api/v2/contracts/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": 60,
  "carrier": {
    "code": "lettresuivie",
    "name": "Lettre Suivie"
  },
  "client_id": "sendcloud-1",
  "is_active": true,
  "is_default": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

The id of the contract you want to retrieve.

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.

Response

OK

User contract

​
id
integer<int64>

Unique identifier of the contract.

Required range: x >= 1
​
client_id
string | null

Client ID of a contract

​
is_active
boolean

Contract's status

​
carrier
object
​
name
string

A custom name set by the user used to identify this contract throughout the platform.

Maximum string length: 50
​
country
string

The country of the contract, as an ISO 3166-1 alpha-2.

Example:

"NL"

​
is_default
boolean

Indicates if the contract is marked as default. When you have multiple active direct contracts for the same carrier, default indicates that the contract will be prioritized over the other direct contracts for the same carrier, when no contract is explicitly mentioned while creating a parcel. You can have only one default direct contract per carrier and it will always be False for the broker and subbroker.