Groups API Reference

Groups

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

Endpoints

`GET`
`POST`
`GET`
`POST`
`GET`
`GET`
`GET`
`GET`
`POST`

List all groups

This endpoint returns a list of groups.

To add or modify group information, use the capture endpoint.

To query data related to groups, use the query endpoint and query the groups table or the events table and properties.$groups.

Required API key scopes

group:read

Path parameters

project_id
string

Query parameters

cursor
string
group_type_index
integer
search
string

Response

Example request

GET /api/projects/:project_id/groups

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

Example response

Status 200

RESPONSE

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "group_type_index": -2147483648,
      "group_key": "string",
      "group_properties": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create groups

Required API key scopes

group:write

Path parameters

project_id
string

Request parameters

group_type_index
integer
group_key
string
group_properties

Response

Example request

POST /api/projects/:project_id/groups

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/\
	-d group_type_index="integer",\
	-d group_key="string"

Example response

Status 201

RESPONSE

{
  "group_type_index": -2147483648,
  "group_key": "string",
  "group_properties": null,
  "created_at": "2019-08-24T14:15:22Z"
}

Retrieve groups activity

Required API key scopes

activity_log:read

Path parameters

project_id
string

Query parameters

group_type_index
integer
id
string

Example request

GET /api/projects/:project_id/groups/activity

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

Example response

Status 200 No response body

Create groups delete property

Required API key scopes

group:write

Path parameters

project_id
string

Query parameters

group_key
string
group_type_index
integer

Request parameters

group_type_index
integer
group_key
string
group_properties

Example request

POST /api/projects/:project_id/groups/delete_property

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/delete_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Example response

Status 200 No response body

Retrieve groups find

Required API key scopes

group:read

Path parameters

project_id
string

Query parameters

group_key
string
group_type_index
integer

Example 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" \
    <ph_app_host>/api/projects/:project_id/groups/find/

Example response

Status 200 No response body

Retrieve groups property definitions

Required API key scopes

group:read

Path parameters

project_id
string

Example 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" \
    <ph_app_host>/api/projects/:project_id/groups/property_definitions/

Example response

Status 200 No response body

Retrieve groups property values

Required API key scopes

group:read

Path parameters

project_id
string

Example 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" \
    <ph_app_host>/api/projects/:project_id/groups/property_values/

Example response

Status 200 No response body

Create groups update property

Required API key scopes

group:write

Path parameters

project_id
string

Query parameters

group_key
string
group_type_index
integer

Request parameters

group_type_index
integer
group_key
string
group_properties

Example request

POST /api/projects/:project_id/groups/update_property

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/update_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Groups

Endpoints

List all groups

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create groups

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve groups activity

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Create groups delete property

Required API key scopes

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve groups find

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Retrieve groups property definitions

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve groups property values

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve groups related

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Create groups update property

Required API key scopes

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Community questions