Skip to navigation
API ReferenceAward DatasetsList referenced awards records

List referenced awards records

Published referenced-awards collection. Existing generic route with a concrete dataset name. Requires data:read. Stable-key identity; ordered by id. q searches title, description.

Authentication

AuthorizationBearer

Create a scoped key at https://app.defdex.io/developer/keys. Keep it private.

Query parameters

limitintegerOptional1-100Defaults to 25
Maximum records per page.
cursorstringOptional<=12000 characters

Opaque next_cursor from the preceding page. Keep dataset, q and filters unchanged.

qstringOptional<=200 characters

Case-insensitive substring on available name, title, description, summary or recipient_name fields; no ranked or fuzzy search.

filtersstringOptional

URL-encoded JSON object; exact equality on up to 12 published fields, AND-combined. Primitive or null values only; strings at most 500 characters. No range, array-containment, OR or sort operators. Allowed fields: id, recipient_id, awarding_agency_id, source_system, external_id, parent_external_id, award_type, title, description, country, currency, obligated_amount, obligated_usd, ceiling_amount, ceiling_usd, announced_on, start_on, end_on, confidence, as_of.

Response headers

X-Request-IdstringOptional
Support identifier on admitted requests.

Response

Success
datalist of objects
next_cursorstring or null
build_idstring

Publication observed for this response; compare across related reads.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
503
Service Unavailable Error