groups

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

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/groups/find/
  • 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

group_keystring required

Specify the key of the group to find

group_type_indexinteger required

Specify the group type to find

skip_create_notebookboolean

When true, do not lazily create the group's CRM notebook. Use for read-only lookups (e.g. resolving a group's display name) that should not have side effects.

Response

group_type_indexinteger required
group_keystring required
group_propertiesobject required

The group's properties.

created_atstring date-time required
notebookstring nullable required

Changes

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