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/

List all groups

Required API key scopes

group: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

  • cursor
    string

    The pagination cursor value.

  • group_type_index
    integer

    Specify the group type to list

  • search
    string

    Search the group name

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

Status 200
RESPONSE
{
  "next": "string",
  "previous": "string",
  "results": [
    {
      "group_type_index": -2147483648,
      "group_key": "string",
      "group_properties": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Retrieve groups find

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

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find

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

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

Retrieve groups property definitions

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/.

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

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

Retrieve groups property values

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

  • group_type_index
    integer

    Specify the group type to find property values of

  • key
    string

    Specify the property key to find values for

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

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

Questions?

Was this page useful?