List contracts
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.opereit.ai/v1/contracts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "<string>",
"carrier_name": "DHL Express",
"signing_date": "2023-12-25",
"status": "PROCESSING",
"rate_count": 123,
"surcharge_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"contract_number": "<string>",
"account_number": "<string>",
"effective_date": "2023-12-25",
"expiration_date": "2023-12-25",
"status_reason": "<string>",
"file_url": "<string>"
}
],
"pagination": {
"cursor": "<string>",
"has_more": true
}
}{
"statusCode": 401,
"statusReasonCode": "AUTHENTICATION_REQUIRED",
"error": "Authentication required"
}Contracts
List contracts
Returns a cursor-paginated list of contracts uploaded by your organization.
GET
/
v1
/
contracts
List contracts
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};
fetch('https://api.opereit.ai/v1/contracts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"id": "<string>",
"carrier_name": "DHL Express",
"signing_date": "2023-12-25",
"status": "PROCESSING",
"rate_count": 123,
"surcharge_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"contract_number": "<string>",
"account_number": "<string>",
"effective_date": "2023-12-25",
"expiration_date": "2023-12-25",
"status_reason": "<string>",
"file_url": "<string>"
}
],
"pagination": {
"cursor": "<string>",
"has_more": true
}
}{
"statusCode": 401,
"statusReasonCode": "AUTHENTICATION_REQUIRED",
"error": "Authentication required"
}Contracts needs to be activated on your account before you can use it. Reach out to your Opereit account manager to get it turned on.
Authorizations
HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).
Query Parameters
Number of items to return per request.
Required range:
1 <= x <= 100Opaque cursor from a previous response. Omit on the first request.
Filter by contract status.
Available options:
PROCESSING, ACTIVE, EXPIRED, FAILED Filter by carrier name (case-insensitive exact match).
Last modified on August 25, 2026