Groups API Reference

Docs
API
Groups

Groups

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

Endpoints

`GET`	`/api/projects/:project_id/groups/`
`GET`	`/api/projects/:project_id/groups/find/`
`GET`	`/api/projects/:project_id/groups/property_definitions/`
`GET`	`/api/projects/:project_id/groups/property_values/`
`GET`	`/api/projects/:project_id/groups/related/`

List all groups

Path Parameters

project_id
string

Query Parameters

cursor
integer
group_type_index
integer

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

Query Parameters

group_key
string
group_type_index
integer

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

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

Query Parameters

group_type_index
integer
key
string

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"
}

Groups

Endpoints

List all groups

Path Parameters

Query Parameters

Response

Request

Response

Retrieve groups find

Path Parameters

Query Parameters

Response

Request

Response

Retrieve groups property definitions

Path Parameters

Response

Request

Response

Retrieve groups property values

Path Parameters

Query Parameters

Response

Request

Response

Questions?

Was this page useful?

Groups

Endpoints

List all groups

Path Parameters

Query Parameters

Response

Request

Response

Retrieve groups find

Path Parameters

Query Parameters

Response

Request

Response

Retrieve groups property definitions

Path Parameters

Response

Request

Response

Retrieve groups property values

Path Parameters

Query Parameters

Response

Request

Response

Retrieve groups related

Path Parameters

Query Parameters

Response

Request

Response

Questions?

Was this page useful?