Skip to main content
GET
/
api
/
v1
/
contract
/
Contract List Api
curl --request GET \
  --url https://api.justpaid.io/api/v1/contract/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "title": "Enterprise Agreement",
    "contract_status": "accepted",
    "contract_start_date": "2024-01-01",
    "contract_end_date": "2025-01-01",
    "contract_amount": 120000,
    "currency": "USD",
    "is_evergreen": false,
    "customer": {
      "uuid": "customer-uuid",
      "name": "Acme Corp",
      "email": "contact@acme.com",
      "external_id": "CUST-001"
    },
    "file_url": "https://api.justpaid.io/files/contract.pdf",
    "created_at": "2024-01-01T00:00:00Z"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customer
string

Filter by customer UUID

​
external_customer_id
string

Filter by external customer ID

​
contract_status
string

Filter by contract status (e.g., 'draft', 'pending', 'accepted')

​
contract_start_date_gte
string<date>

Filter contracts starting on or after this date

​
contract_start_date_lte
string<date>

Filter contracts starting on or before this date

​
contract_end_date_gte
string<date>

Filter contracts ending on or after this date

​
contract_end_date_lte
string<date>

Filter contracts ending on or before this date

​
is_evergreen
boolean

Filter by evergreen status

​
limit
integer

Number of results to return per page

​
offset
integer

The initial index from which to return the results

Response

200 - application/json

List of contracts

​
items
ContractListOut · object[]
required
​
count
integer
required