List vendor contracts

GET /api/v1/vendor-contracts

List all vendor contracts/MSAs for the business.

Operation ID: list_vendor_contracts_api_v1_vendor_contracts_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

vendor_id string

Filter by vendor UUID

status string

Filter by status: draft, active, expired, terminated

cursor string

Cursor for pagination

limit integer

Pagination limit

direction string default: next

Pagination direction: 'next' or 'prev'

include_total_count boolean default: False

Whether to include total count (expensive - avoid if possible)

sort_by string

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descending boolean default: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

200 Successful Response

Schema: VendorContractListResponse

items array · VendorContractResponse requiredVendorContractResponse

List of items

14 fields
name string required

Contract/agreement name.

vendor_id string required

Vendor UUID.

status string

Contract status: draft, active, expired, terminated.

effective_date string · date

Contract start date.

expiration_date string · date

Contract end date.

contracted_amount_cents integer

Agreed amount per billing period in cents.

billing_frequency string

Billing frequency: monthly, quarterly, annually, one_time, weekly, biweekly.

terms_summary string

Summary of key contract terms (AI-extracted or manual).

s3_key string

S3 key for the original MSA/contract PDF.

id string required

Contract UUID.

business_id string required

Business UUID.

vendor_name string

Vendor name (resolved).

created_at string
updated_at string
total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object