Groups

For instructions on how to authenticate to use this endpoint, see API overview.

List all groups types

Required API key scopes

group:read

Path parameters

  • project_id
    string

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

Request

GET /api/projects/:project_id/groups_types
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/groups_types/

Response

Status 200
RESPONSE

Update groups types update metadata

Path parameters

  • project_id
    string

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

Request parameters

  • name_singular
    string
  • name_plural
    string

Response


Request

PATCH /api/projects/:project_id/groups_types/update_metadata
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    https://app.posthog.com/api/projects/:project_id/groups_types/update_metadata/\
	-d group_type="string"

Response

Status 200
RESPONSE
{
  "group_type": "string",
  "group_type_index": 0,
  "name_singular": "string",
  "name_plural": "string"
}

Questions?

Was this page useful?