Skip to main content
GET
List attribute definitions

Authorizations

Authorization
string
header
required

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

Path Parameters

projectId
string
required

Project ID

Query Parameters

limit
integer
default:20

Max items per page (1-100, default 20).

Required range: 1 <= x <= 100
cursor
string

Opaque page cursor — the cursor query value found inside a prior response's next/previous URL. Normally you never build this yourself: just GET those URLs as-is.

name
string

Filter by name (case-insensitive substring match).

scope
enum<string>

Filter by scope: user, company, companyMembership, or eventDefinition (event attributes — attach them to events via the event-definitions surface).

Available options:
user,
company,
companyMembership,
eventDefinition
orderBy

Order by createdAt / codeName / displayName (prefix - for descending). Text sorting is case-sensitive (byte order): uppercase sorts before lowercase.

Available options:
createdAt,
-createdAt,
codeName,
-codeName,
displayName,
-displayName
eventName

Filter to attributes attached to these event(s), matched by event codeName (EXACT match — not displayName; a displayName silently matches nothing). Multiple values OR together.

Response

List of attribute definitions

results
object[]
required
next
string | null
required

Full URL of the next page — request it as-is (it already carries cursor= and your query parameters). null = no further pages.

previous
string | null
required

Full URL of the previous page — request it as-is. null = already at the first page.