Retrieve a contract
GET {{baseUrl}}/contracts/:id?carrier=<string>&is_active=<boolean>&client_id=<string>&name=<string>
Include the contract_ID for a specific direct contract as a query parameter to retrieve information for this
single contract.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
carrier | string | The carrier you want to filter for, for instance: postnl. You can find available carriers in your Sendcloud account settings. | |
is_active | string | 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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"id":"\u003clong\u003e","client_id":"\u003cstring\u003e","is_active":"\u003cboolean\u003e","carrier":{"code":"\u003cstring\u003e","name":"\u003cstring\u003e"},"name":"\u003cstring\u003e","country":"\u003cstring\u003e","is_default":"\u003cboolean\u003e"}