property_definitions

get/api/projects/{project_id}/property_definitions/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/property_definitions/
  • Auth: HTTP bearer

Path parameters

project_idstring required

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

Query parameters

event_namesstring

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

exclude_core_propertiesboolean

Whether to exclude core properties

exclude_hiddenboolean

Whether to exclude properties marked as hidden

exclude_restrictedboolean

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

excluded_propertiesstring

JSON-encoded list of excluded properties

filter_by_event_namesboolean nullable

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.

group_type_indexinteger

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

is_feature_flagboolean nullable

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.

is_numericalboolean nullable

Whether to return only (or excluding) numerical property definitions

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

propertiesstring

Comma-separated list of properties to filter

searchstring

Searches properties by name

type'event' | 'person' | 'group' | 'session'

What property definitions to return

  • event - event
  • person - person
  • group - group
  • session - session
verifiedboolean nullable

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

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

No recorded changes to this operation across all 1 revision of this API.