Skip to main content
POST
Reveal Sensitive Entity Field Value

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

entity_id
string
required

The ID of the entity.

Body

application/json
fieldId
string
required

The field's ID as returned in field_values[].field_id by entity reads. Set exactly one of field_id or field_key.

includeHistory
boolean

Also return the field's value history on this entity, most recent first. Recorded on the audit event.

Response

200 - application/json

Success

data
data · object

The current value. sensitive is false and value is set when the entity stores one.

history
EntityFieldValue · object[]

Present only when include_history was requested.