Skip to navigation
API ReferenceCatalog and Generic AccessList records

List records

Read any published dataset. Use the named collection reference for field-level schemas. Requires data:read.

Authentication

AuthorizationBearer

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

Path parameters

datasetenumRequired

Exact identifier; not a website URL.

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.

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.

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