Property

For instructions on how to authenticate to use this endpoint, see API overview.

Retrieve property definitions

Required API key scopes

property_definition:read

Path parameters

  • project_id
    string

    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_names
    string

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

  • excluded_properties
    string

    JSON-encoded list of excluded properties

  • filter_by_event_names
    boolean

    Whether to return only properties for events in event_names

  • group_type_index
    integer

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

  • is_feature_flag
    boolean

    Whether to return only (or excluding) feature flag properties

  • is_numerical
    boolean

    Whether to return only (or excluding) numerical property definitions

  • properties
    string

    Comma-separated list of properties to filter

  • search
    string

    Searches properties by name

  • type
    string
    Default: event
    One of: "event""person""group""session"

    What property definitions to return

    • event - event
    • person - person
    • group - group
    • session - session

Request

GET /api/projects/:project_id/property_definitions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/property_definitions/

Response

Status 200 No response body

Retrieve property definitions retrieve

Required API key scopes

property_definition:read

Path parameters

  • id
    string

    A UUID string identifying this property definition.

  • project_id
    string

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

Request

GET /api/projects/:project_id/property_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/property_definitions/:id/

Response

Status 200 No response body

Update property definitions

Required API key scopes

property_definition:write

Path parameters

  • id
    string

    A UUID string identifying this property definition.

  • project_id
    string

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

Request

PATCH /api/projects/:project_id/property_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/property_definitions/:id/

Response

Status 200 No response body

Delete property definitions

Required API key scopes

property_definition:write

Path parameters

  • id
    string

    A UUID string identifying this property definition.

  • project_id
    string

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

Request

DELETE /api/projects/:project_id/property_definitions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/property_definitions/:id/

Response

Status 204 No response body

Retrieve property definitions seen together

Allows a caller to provide a list of event names and a single property name Returns a map of the event names to a boolean representing whether that property has ever been seen with that event_name

Required API key scopes

property_definition:read

Path parameters

  • project_id
    string

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

Request

GET /api/projects/:project_id/property_definitions/seen_together
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/property_definitions/seen_together/

Response

Status 200 No response body

Questions?

Was this page useful?