Records

List Keywords Endpoint

List all keywords for a record, marking analysis-inherited ones.

get/records/{record_id}/keywords/

Request

The document declares no server URL.
Auth: one of:
- none
- OAuth 2 (password, token URL /api/auth/login)
- API key in header X-Api-Key
- API key in query parameter api_key

Path parameters

record_idstring uuid required

Query parameters

skipinteger

limitinteger

audience_visibilitystring nullable

Compute inherited_audience_gap as if the record had this visibility. Honored only for the record's owner and admins; ignored for everyone else, who get the gap at the record's stored state. Keywords themselves are unaffected.

audience_record_statusstring nullable

Compute inherited_audience_gap as if the record had this status — the counterfactual an owner asks before publishing. Honored only for the record's owner and admins; ignored for everyone else, who get the gap at the record's stored state. Deliberately not pinned to an enum: the lifecycle statuses come from the workflow extension's status_order(), so an overlay may define its own. An unrecognized status is treated conservatively (it reaches only the owner, which errs toward warning) rather than rejected.

Response

Successful Response

totalinteger required

inherited_audience_gapboolean

True when at least one keyword is inherited AND this record's audience — at its stored state, or at the counterfactual audience_visibility/audience_record_status query parameters, which are honored only for the record's owner and admins — includes someone who cannot open the source dataset.

Changes

No recorded changes to this operation across all 50 revisions of this API.