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

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

Use this file to discover all available pages before exploring further.

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.

Response

OK

Retrieve contract

data
Contract ยท object

User contract