event_definitions

Resolve team-configured primary properties for event definitions.

The response only contains entries where a non-null primary_property is set on the EventDefinition. Callers should fall back to the core taxonomy defaults client-side for names not present in the response.

get/api/projects/{project_id}/event_definitions/primary_properties/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/event_definitions/primary_properties/
  • 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

namesstring[]

Optional: restrict the response to these event names. Repeat the parameter for multiple names (e.g. ?names=a&names=b). When omitted, returns every team-configured primary property.

Response

primary_propertiesobject required

Mapping from event name to the team-configured primary property for that event. Names without a configured primary property are omitted; callers should fall back to the core taxonomy defaults for those.

Changes

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