List All Custom Attributes

GET/v1/custom-attributes

Returns custom attribute definitions for the workspace, ordered by created_at descending.

Query Parameters

pageinteger

Example:1

per_pageinteger

Example:25

qstring

Search by display_name or key

Example:department

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataarray[object] required

idstring (ulid) required

Example:01HXYZABCDEFGHJKLMNPQRSTUV

display_namestring required

Example:Department

description[ "string", "null" ]

Example:Contact department

keystring required

Example:department

typeenum: text | number | list required

Example:text

list_valuesarray[string]•Present when type is list

Example:[ "sales", "support" ]

created_atstring (date-time) required

updated_atstring (date-time) required

metaobject required

current_pageinteger

Example:1

per_pageinteger

Example:25

totalinteger

Example:1

last_pageinteger

Example:1

linksobject

first[ "string", "null" ]

last[ "string", "null" ]

prev[ "string", "null" ]

next[ "string", "null" ]

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-stg.bevatelcloud.com/v1/custom-attributes?page=1&per_page=25&q=department" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": [
    {
      "id": "01HXYZABCDEFGHJKLMNPQRSTUV",
      "display_name": "Department",
      "key": "department",
      "type": "text",
      "list_values": [],
      "created_at": "2024-01-01T12:00:00Z",
      "updated_at": "2024-01-01T12:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 25,
    "total": 1,
    "last_page": 1,
    "links": {}
  }
}