v5

OpenAPI 3.1.02026-08-037720751.3 KB

Attributes

List select options

Lists all select options for a particular attribute on either an object or a list.

When target is objects, the required scopes are object_configuration:read. When target is lists, the required scopes are list_configuration:read.

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

Path parameters

target'objects' | 'lists' required

Whether the attribute is on an object or a list.

Example:lists

identifierstring required

A UUID or slug to identify the object or list the select attribute belongs to.

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

attributestring required

A UUID or slug to identify the attribute you want to list select options on.

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

Query parameters

show_archivedboolean

true if you want the results to include archived select options.

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",
        "option_id": "08c2c59a-c18e-40c6-8dc4-95415313b2ea"
      },
      "title": "Medium"
    }
  ]
}