Groups
For instructions on how to authenticate to use this endpoint, see API overview.
List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/
Endpoints
List all groups
Path Parameters
- project_idstring
Query Parameters
- cursorstring
- group_type_indexinteger
- searchstring
Response
Request
GET
/api /projects /:project_id /groups
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/groups/
Response
RESPONSE
{"next": "string","previous": "string","results": [{"group_type_index": -2147483648,"group_key": "string","group_properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z"}]}
Retrieve groups find
Path Parameters
- project_idstring
Query Parameters
- group_keystring
- group_type_indexinteger
Response
Request
GET
/api /projects /:project_id /groups /find
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/groups/find/
Response
RESPONSE
{"group_type_index": -2147483648,"group_key": "string","group_properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z"}
Retrieve groups property definitions
Path Parameters
- project_idstring
Response
Request
GET
/api /projects /:project_id /groups /property_definitions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/groups/property_definitions/
Response
RESPONSE
{"group_type_index": -2147483648,"group_key": "string","group_properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z"}
Retrieve groups property values
Path Parameters
- project_idstring
Query Parameters
- group_type_indexinteger
- keystring
Response
Request
GET
/api /projects /:project_id /groups /property_values
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/groups/property_values/
Response
RESPONSE
{"group_type_index": -2147483648,"group_key": "string","group_properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z"}