List record attribute values
Gets all values for a given attribute on a record. If the attribute is historic, this endpoint has the ability to return all historic values using the show_historic
query param.
Required scopes: record_permission:read
, object_configuration:read
.
Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Path Parameters
A UUID or slug to identify the object the record belongs to.
"people"
A UUID to identify the record you want to query values on.
"891dcbfc-9141-415d-9b2a-2238a6cc012d"
A UUID or slug to identify the attribute you want to query values on.
"41252299-f8c7-4b5e-99c9-4ff8321d2f96"
Query Parameters
If true
, the endpoint will return all historic values for the attribute. If false
, the endpoint will only return the currently active value(s). Defaults to false
. Can only be set to true
for attributes which support historic data; the endpoint will throw if set to true
for non-historic attributes.
true
The maximum number of results to return. See the full guide to pagination here.
10
The number of results to skip over before returning. See the full guide to pagination here.
5
Was this page helpful?