provider groups GET
/api/projects/{project_id}/groups/ @utdk/posthog
/api/projects/{project_id}/groups/ groups_list
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.
- cursor query
- Pagination cursor returned in the `next` URL of a previous response
- string
- group_key query
- Filter groups whose key contains this string (case-insensitive)
- string
- group_type_index query required
- Specify the group type to list
- 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
- search query
- Search the group name
- string
Try it
Authentication
Configure credentials for PostHog API
Code snippet
Updates live as you fill in the form above.
TypeScript
import posthog from '@utdk/posthog';
await posthog.groupsList()