Provenance history for a record

View as Markdown

Returns paginated field-level provenance rows ordered by effectiveAt DESC.

Authentication

AuthorizationBearer

User bearer token: Supabase or Clerk session JWT, Clerk OAuth access token, or Clerk personal API key

OR
X-API-Keystring

Admin API key for system-to-system write operations

OR
X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

Query parameters

tableNameenumRequired

Tracked resource. Canonical form is the camelCase wire token (e.g. entity, newsArticle); the legacy Postgres table name (res_entity) is still accepted for backwards compatibility.

recordIdstringOptional

Record key of the tracked row (text)

pageintegerOptional>=0Defaults to 0

Zero-based page index (0..N)

sizeintegerOptional>=1Defaults to 25
The size of the page to be returned
sortlist of stringsOptionalDefaults to ["effectiveAt,DESC"]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

OK
contentlist of objectsOptional
emptybooleanOptional
firstbooleanOptional
lastbooleanOptional
numberintegerOptional
numberOfElementsintegerOptional
pageableobjectOptional
sizeintegerOptional
sortobjectOptional
totalElementslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error