Skip to main content
GET
List Custom Attribute Definitions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

label
string | null

Return the single unified definition for this exact label.

config_type
enum<string> | null

Filter by the entity type the attribute attaches to. Only user definitions are listed.

Available options:
user
source_type
enum<string> | null

Filter by where the attribute comes from: synced from a connected app, native defined by your team in Lumos, or ai-generated inferred by Lumos.

Available options:
synced,
native,
ai-generated
attribute_type
enum<string> | null

Filter by the type of value the attribute holds.

Available options:
string,
boolean,
integer,
datetime,
json,
user,
group,
single-select
app_id
string<uuid> | null

UUID of an app. Returns only the definitions that app supplies.

page_token
string | null

Opaque cursor from a previous response's next_page_token. Omit to fetch the first page. Treat as opaque: do not decode, construct, or interpret it.

page_size
integer
default:100

Maximum number of items to return per page. Values above 1000 are clamped to 1000 rather than rejected.

Required range: x >= 1

Response

Successful Response

custom_attribute_definitions
CustomAttributeDefinition · object[]
required

Custom attribute definitions returned in this page.

next_page_token
string | null

Token for the next page, or null when this is the last page. An absent token is the only end-of-results signal. A page holding fewer than page_size items does not mean the results are exhausted. Treat the value as opaque: do not decode, construct, or interpret it.