Sign in

v6

latestOpenAPI 3.1.0raw.githubusercontent.com2025-04-245712812.6 KB
Records

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.

get/v2/objects/{object}/records/{record_id}/attributes/{attribute}/values

Path parameters

objectstring required

A UUID or slug to identify the object the record belongs to.

Example:people
record_idstring uuid required

A UUID to identify the record you want to query values on.

Example:891dcbfc-9141-415d-9b2a-2238a6cc012d
attributestring required

A UUID or slug to identify the attribute you want to query values on.

Example:41252299-f8c7-4b5e-99c9-4ff8321d2f96

Query parameters

show_historicboolean

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.

Example:true
limitinteger

The maximum number of results to return. See the full guide to pagination here.

Example:10
offsetinteger

The number of results to skip over before returning. See the full guide to pagination here.

Example:5

Response

Success

Example response

{
  "data": [
    {
      "active_from": "2023-01-01T15:00:00.000000000Z",
      "active_until": "2023-01-01T15:00:00.000000000Z",
      "created_by_actor": {
        "type": "workspace-member",
        "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
      },
      "referenced_actor_type": "workspace-member",
      "referenced_actor_id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
      "attribute_type": "actor-reference"
    }
  ]
}