groups

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

Uses forward-only keyset pagination via the cursor parameter. The previous field in the response envelope is always null.

get/api/projects/{project_id}/groups/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/groups/
  • Auth: HTTP bearer

Path parameters

project_idstring required

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

cursorstring

Pagination cursor returned in the next URL of a previous response

group_keystring

Filter groups whose key contains this string (case-insensitive)

group_type_indexinteger required

Specify the group type to list

searchstring

Search the group name

Response

group_type_indexinteger required
group_keystring required
group_propertiesobject required

The group's properties.

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.