provider groups GET /api/projects/{project_id}/groups/find/
@utdk/posthog /api/projects/{project_id}/groups/find/
groups_find_retrieve
group_key query required
Specify the key of the group to find
string
group_type_index query required
Specify the group type to find
integer
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string
skip_create_notebook query
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.
boolean

Try it

Authentication
Configure credentials for PostHog API
groupsFindRetrieve
GET/api/projects/{project_id}/groups/find/

Parameters

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

required

Specify the key of the group to find

required

Specify the group type to find

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.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.groupsFindRetrieve()