v1

latestOpenAPI 3.0.32026-08-068925782.3 MB
Agreements

get/agreements

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

activeboolean

Filter for: active

lookups: eq, ne

createdstring date-time

Filter for: created

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

forms.idstring

Filter for: forms.id

lookups: eq, ne, like, ilike, null, in, out

forms__type'enroll' | 'product' | 'item'

Filter for: forms__type

lookups: eq, ne, like, ilike, in, out

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

marketplace.idstring

Filter for: marketplace.id

lookups: eq, ne, like, ilike, null, in, out

marketplace.namestring

Filter for: marketplace.name

lookups: eq, ne, like, ilike, in, out

search: true

marketplace__idstring

Filter for: marketplace__id

lookups: eq, ne, like, ilike, null, in, out

marketplace__namestring

Filter for: marketplace__name

lookups: eq, ne, like, ilike, in, out

search: true

owner.idstring

Filter for: owner.id

lookups: eq, ne, like, ilike, null, in, out

owner.namestring

Filter for: owner.name

lookups: eq, ne, like, ilike, in, out

search: true

owner__idstring

Filter for: owner__id

lookups: eq, ne, like, ilike, null, in, out

owner__namestring

Filter for: owner__name

lookups: eq, ne, like, ilike, in, out

search: true

titlestring

Filter for: title

lookups: eq, ne, like, ilike, in, out

search: true

type'distribution' | 'program' | 'service' | 'syndication' | 'referral'

Filter for: type

lookups: eq, ne, like, ilike, in, out

updatedstring date-time

Filter for: updated

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

Response

idstring
type'distribution' | 'program' | 'service' | 'syndication' | 'referral'
titlestring
namestring required
descriptionstring required
createdstring date-time
updatedstring date-time
document_type'external' | 'uploaded' | 'none'
linkstring uri
filestring binary nullable
activeboolean
auto_acceptboolean