Sign in
admin-inventory

List Contracts

List vendor contracts.

get/api/admin/inventory/contracts

Query parameters

vendorIdstring nullable
statusstring nullable

DRAFT, ACTIVE, ENDED or CANCELLED.

DRAFT, ACTIVE, ENDED or CANCELLED.

typestring nullable

ONE_OFF, RECURRING or RENEWABLE.

ONE_OFF, RECURRING or RENEWABLE.

activeOnstring date nullable

ISO date; keep only contracts whose window covers it.

ISO date; keep only contracts whose window covers it.

searchstring nullable

Case-insensitive match against name, reference, or id.

Case-insensitive match against name, reference, or id.

offsetinteger

Number of items to skip.

Number of items to skip.

limitinteger

Max items to return (1-100).

Max items to return (1-100).

Response

Successful Response

total_countinteger

Total number of items available in the dataset

offsetinteger

Number of items to skip before starting to collect the result set

limitinteger

Maximum number of items to return

statusstring nullable

Response status

Changes

Changed in 1 of the 11 revisions of this API.1