Skip to main content
GET
Retrieves contracts

Authorizations

Authorization
string
header
required

OAuth2 Bearer Authorization

Query Parameters

customerNumber
string

Customers number

name
string

Business, company name, or personal name of customer

extContractId
string

External contract ID

status
enum<string>

Contract status

Available options:
open,
cancellation_previous,
delivery_net,
waiting,
active,
blocked,
terminated,
expired,
done,
cancelled
limit
integer<int64>

Maximum number of items per page. Maximum value is 25.

Required range: 1 <= x <= 25
Example:

"10"

page
integer<int64>

Page number to retrieve (starting from 1).

Required range: x >= 1
Example:

"1"

Response

Contract collection

contracts
object[]
required

Contracts

pagination
object

Pagination