Skip to navigation

Get related records

Read an allowlisted relationship with a server-enforced parent filter. Organization awards mean direct recipient; agency awards mean awarding agency; funded-awards means funding agency. Program participant/system relations return relationship rows. Requires data:read. See the entity access guide for the complete relationship map. Parent/child reads must observe the same build.

Authentication

AuthorizationBearer

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

Path parameters

collectionenumRequired

Exact identifier; not a website URL.

identifierstringRequired

Exact identifier; not a website URL.

relationshipstringRequired

Exact identifier; not a website URL.

Query parameters

byenumOptional

Default: UUID-like identifiers use id; otherwise slug. External organization identifiers require scheme.

Allowed values:
schemestringOptional<=100 characters

Exact published organization-identifiers scheme, required for by=external.

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.

wherestringOptional

URL-encoded JSON object, at most 12 fields. Numeric/date gt, gte, lt, lte bounds; in accepts 1–20 non-null scalar values. Predicates are AND-combined.

sortstringOptional<=120 characters

Published scalar field with :asc or :desc. NULLS LAST with deterministic tie-breaker. Custom-sorted pagination is build-bound and capped at 10,000 matches.

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. For ranges and scalar membership use where; for ordering use sort. No array-containment or OR operators.

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.

truncatedbooleanOptional

True when more matches exist past the 10,000-position cap. Narrow exact filters; null next_cursor alone does not prove a complete export.

datasetstringOptional
relationshipstringOptional
parent_idstringOptionalformat: "uuid"

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