v6

latestOpenAPI 3.1.02026-08-047720752.5 KB

Entries

List attribute values for a list entry

Gets all values for a given attribute on a list entry. This endpoint has the ability to return all historic values using the show_historic query param. Historic values are sorted from oldest to newest (by active_from).

Required scopes: list_entry:read, list_configuration:read.

get/v2/lists/{list}/entries/{entry_id}/attributes/{attribute}/values

Path parameters

liststring required

A UUID or slug identifying the list the entry is in.

Example:enterprise_sales

entry_idstring uuid required

A UUID identifying the entry.

Example:2e6e29ea-c4e0-4f44-842d-78a891f8c156

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"
    }
  ]
}