Skip to main content
GET
Get Custom Attribute Definition

Authorizations

Authorization
string
header
required

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

Path Parameters

definition_id
string<uuid>
required

Response

Successful Response

A custom-attribute definition: the schema behind custom-attribute values.

There is one definition per label, unified across every app that supplies it.

id
string
required

UUID of this definition.

label
string
required

Display name, unique among your organization's definitions of a config_type.

attribute_type
enum<string>
required

The type of value the attribute holds.

Available options:
string,
boolean,
integer,
datetime,
json,
user,
group,
single-select
config_type
enum<string>
required

Entity type this attribute attaches to. Always user.

Available options:
user
source_type
enum<string>
required

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
name
string | null

Representative machine/synced attribute name.