provider groups GET /api/environments/{environment_id}/groups/
@utdk/posthog /api/environments/{environment_id}/groups/
environments_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
environment_id path required
Deprecated. Use /api/projects/{project_id}/ instead.
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
search query
Search the group name
string

Try it

Authentication
Configure credentials for PostHog API
environmentsGroupsList
GET/api/environments/{environment_id}/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.

Parameters

required

Deprecated. Use /api/projects/{project_id}/ instead.

Pagination cursor returned in the `next` URL of a previous response

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

required

Specify the group type to list

Search the group name

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.environmentsGroupsList()