provider property_definitions GET /api/projects/{project_id}/property_definitions/
@utdk/posthog /api/projects/{project_id}/property_definitions/
property_definitions_list
event_names query
If sent, response value will have `is_seen_on_filtered_events` populated. JSON-encoded
string
exclude_core_properties query
Whether to exclude core properties
boolean
exclude_hidden query
Whether to exclude properties marked as hidden
boolean
exclude_restricted query
Whether to exclude properties that the current user does not have read access to via field-level access control
boolean
excluded_properties query
JSON-encoded list of excluded properties
string
filter_by_event_names query
Whether to return only properties for events in `event_names`. Note: this event scoping does not apply to feature flag properties ($feature/*), which are global and not tracked per-event; to retrieve feature flags use is_feature_flag=true instead.
booleannull
group_type_index query
What group type is the property for. Only should be set if `type=group`
integer
is_feature_flag query
Whether to return only (or excluding) feature flag properties ($feature/*). Flags are global, not per-event, so they can't be scoped by event_names/filter_by_event_names — pass is_feature_flag=true to list them all.
booleannull
is_numerical query
Whether to return only (or excluding) numerical property definitions
booleannull
limit query
Number of results to return per page.
integer
offset query
The initial index from which to return the results.
integer
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string
properties query
Comma-separated list of properties to filter
string
search query
Searches properties by name
string
type query
What property definitions to return * `event` - event * `person` - person * `group` - group * `session` - session
enum: event, person, group, session
verified query
Filter by verified status. True returns only verified, false returns only unverified.
booleannull

Try it

Authentication
Configure credentials for PostHog API
propertyDefinitionsList
GET/api/projects/{project_id}/property_definitions/

Parameters

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

If sent, response value will have `is_seen_on_filtered_events` populated. JSON-encoded

Whether to exclude core properties

Whether to exclude properties marked as hidden

Whether to exclude properties that the current user does not have read access to via field-level access control

JSON-encoded list of excluded properties

Whether to return only properties for events in `event_names`. Note: this event scoping does not apply to feature flag properties ($feature/*), which are global and not tracked per-event; to retrieve feature flags use is_feature_flag=true instead.

What group type is the property for. Only should be set if `type=group`

Whether to return only (or excluding) feature flag properties ($feature/*). Flags are global, not per-event, so they can't be scoped by event_names/filter_by_event_names — pass is_feature_flag=true to list them all.

Whether to return only (or excluding) numerical property definitions

Number of results to return per page.

The initial index from which to return the results.

Comma-separated list of properties to filter

Searches properties by name

What property definitions to return * `event` - event * `person` - person * `group` - group * `session` - session

Filter by verified status. True returns only verified, false returns only unverified.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.propertyDefinitionsList({
  "exclude_core_properties": false,
  "exclude_hidden": false,
  "exclude_restricted": false,
  "type": "event"
})