v1

latestOpenAPI 3.1.02026-07-14402976.1 KB
Companies

List company record attribute values

Gets all values for a given attribute on a company 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/companies/records/{record_id}/attributes/{attribute}/values

Path parameters

record_idstring required

A UUID of the company record to fetch attribute values for.

Example:99a03ff3-0435-47da-95cc-76b2caeb4dab
attributestring required

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

Example:domains

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": null,
      "created_by_actor": {
        "type": "workspace-member",
        "id": "a976f6a9-fc2b-4acb-91e7-afb2d18b4e64"
      },
      "domain": "attio.com",
      "root_domain": "attio.com",
      "attribute_type": "domain"
    }
  ]
}