Skip to main content
GET
List Project Data Definitions
Closed Beta
Available to a limited set of invited customers. Contact your account team to join. The request and response contract may change before general availability (GA).

Authorizations

Authorization
string
header
required

This endpoint uses Service Account authentication.

Headers

Mixpanel-Version
string
default:2026-08-13

Optional date-based API version pin.

If omitted, the request is served by the latest API version, and the caller accepts that a future release may introduce a breaking change to the response contract. If set to a supported version date, that version's contract is honored and will not receive a breaking change.

Path Parameters

project_id
string
required

The unique identifier for the project.

Query Parameters

page_size
integer
default:100

Items per page.

Required range: 1 <= x <= 1000
cursor
string | null

Previous or next cursor used to paginate.

order
enum<string>
default:asc

Sort order by name: 'asc' or 'desc'.

Available options:
asc,
desc
name
string | null

Case-insensitive substring of the definition name.

type
enum<string>[]

Only definitions of these types.

Available options:
event,
custom_event,
event_property,
custom_property,
metric,
behavior,
cohort
event_name
string | null

Only properties of this event.

status
enum<string>[]

Only definitions with one of these statuses.

Available options:
visible,
hidden,
blocked
tag
string[]

Only definitions carrying one of these tags.

owner_user_id
string[]

Only definitions owned by one of these users.

Required string length: 1 - 64
owner_team_id
string[]

Only definitions owned by one of these teams.

Required string length: 1 - 64
has_description
boolean | null

Whether the definition has a description.

has_owner
boolean | null

Whether the definition has an owner.

verified
boolean | null

Whether the definition is verified.

Response

OK

A page of a project's data definitions, ordered by name.

results
(DataDefinitionWithoutBodyResponse · object | CustomEventDataDefinitionResponse · object | CustomPropertyDataDefinitionResponse · object | BehaviorDataDefinitionResponse · object | MetricDataDefinitionResponse · object | CohortDataDefinitionResponse · object)[]
required

List of items for the current page.

An event or event property, which has no definition body.

pagination
CursorPaginationResponse · object
required

Pagination cursors to navigate through the results.