Skip to main content
GET
/
v1
/
contracts
List contracts
curl --request GET \
  --url https://api.opereit.com/v1/contracts \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "id": "<string>",
      "carrier_name": "DHL Express",
      "signing_date": "2023-12-25",
      "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
  }
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Auth using your API key. Send Authorization: Basic base64(key_id:key_secret).

Query Parameters

​
limit
integer
default:50

Number of items to return per request.

Required range: 1 <= x <= 100
​
cursor
string

Opaque cursor from a previous response. Omit on the first request.

​
status
enum<string>

Filter by contract status.

Available options:
PROCESSING,
ACTIVE,
EXPIRED,
FAILED
​
carrier_name
string

Filter by carrier name (case-insensitive exact match).

Response

Cursor-paginated list of contracts.

​
data
object[]
required
​
pagination
object
required