Sign in
Attributes

List attributes

Lists all attributes defined on a specific object or list. Attributes are returned in the order that they are sorted by in the UI.

Required scopes: object_configuration:read.

get/v2/{target}/{identifier}/attributes

Path parameters

target'objects' | 'lists' required

Whether the attributes are on an object or a list.

Example:lists
identifierstring required

A UUID or slug to identify the object or list the attributes belong to.

Example:33ebdbe9-e529-47c9-b894-0ba25e9c15c0

Query parameters

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
show_archivedboolean

Whether archived attributes should be included in the results. See the full guide to archiving here.

Example:true

Response

Success

Example response

{
  "data": [
    {
      "id": {
        "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
        "object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795",
        "attribute_id": "41252299-f8c7-4b5e-99c9-4ff8321d2f96"
      },
      "title": "Rating",
      "description": "Rating of the record out of 5",
      "api_slug": "Rating",
      "type": "rating",
      "is_system_attribute": false,
      "is_writable": true,
      "is_required": false,
      "is_unique": false,
      "is_multiselect": false,
      "is_default_value_enabled": false,
      "is_archived": false,
      "default_value": null,
      "relationship": null,
      "created_at": "2021-11-21T13:22:49.061Z",
      "config": {
        "currency": {
          "default_currency_code": null,
          "display_type": null
        },
        "record_reference": {
          "allowed_object_ids": null
        }
      }
    }
  ]
}

Changes

Changed in 1 of the 6 revisions of this API.1