Core-10

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

Endpoints

GET
POST
GET
POST
GET
GET
GET
GET
POST
GET
POST
DELETE
POST
GET
POST
GET
DELETE
GET
GET
GET

List all 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/

Required API key scopes

group:read

Path parameters

  • project_id
    string

Query parameters

  • cursor
    string
  • group_type_index
    integer
  • search
    string

Response


Example request

GET /api/projects/:project_id/groups
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/

Example response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "group_type_index": -2147483648,
      "group_key": "string",
      "group_properties": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create groups create

Required API key scopes

group:write

Path parameters

  • project_id
    string

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Response


Example request

POST /api/projects/:project_id/groups
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/\
	-d group_type_index="integer",\
	-d group_key="string"

Example response

Status 201
RESPONSE
{
  "group_type_index": -2147483648,
  "group_key": "string",
  "group_properties": null,
  "created_at": "2019-08-24T14:15:22Z"
}

Retrieve groups activity retrieve

Required API key scopes

activity_log:read

Path parameters

  • project_id
    string

Query parameters

  • group_type_index
    integer
  • id
    string

Example request

GET /api/projects/:project_id/groups/activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/activity/

Example response

Status 200 No response body

Create groups delete property create

Required API key scopes

group:write

Path parameters

  • project_id
    string

Query parameters

  • group_key
    string
  • group_type_index
    integer

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Example request

POST /api/projects/:project_id/groups/delete_property
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/delete_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Example response

Status 200 No response body

Retrieve groups find retrieve

Required API key scopes

group:read

Path parameters

  • project_id
    string

Query parameters

  • group_key
    string
  • group_type_index
    integer

Example request

GET /api/projects/:project_id/groups/find
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/find/

Example response

Status 200 No response body

Retrieve groups property definitions retrieve

Required API key scopes

group:read

Path parameters

  • project_id
    string

Example request

GET /api/projects/:project_id/groups/property_definitions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/property_definitions/

Example response

Status 200 No response body

Retrieve groups property values retrieve

Required API key scopes

group:read

Path parameters

  • project_id
    string

Example request

GET /api/projects/:project_id/groups/property_values
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/property_values/

Example response

Status 200 No response body

Create groups update property create

Required API key scopes

group:write

Path parameters

  • project_id
    string

Query parameters

  • group_key
    string
  • group_type_index
    integer

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Example request

POST /api/projects/:project_id/groups/update_property
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/update_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Example response

Status 200 No response body

List all insights sharing list

Required API key scopes

sharing_configuration:read

Path parameters

  • insight_id
    integer
  • project_id
    string

Example request

GET /api/projects/:project_id/insights/:insight_id/sharing
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/insights/:insight_id/sharing/

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Create insights sharing passwords create

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • project_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/insights/:insight_id/sharing/passwords
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/insights/:insight_id/sharing/passwords/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Delete insights sharing passwords destroy

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • password_id
    string
  • project_id
    string

Example request

DELETE /api/projects/:project_id/insights/:insight_id/sharing/passwords/:password_id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/insights/:insight_id/sharing/passwords/:password_id/

Example response

Status 204 No response body

Create insights sharing refresh create

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • project_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/insights/:insight_id/sharing/refresh
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/insights/:insight_id/sharing/refresh/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

List all integrations list

Required API key scopes

integration:read

Path parameters

  • project_id
    string

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/integrations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/integrations/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "kind": "slack",
      "config": null,
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "errors": "string",
      "display_name": "string"
    }
  ]
}

Create integrations create

Required API key scopes

integration:write

Path parameters

  • project_id
    string

Request parameters

  • kind
  • config

Response


Example request

POST /api/projects/:project_id/integrations
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/integrations/\
	-d kind=undefined

Example response

Status 201
RESPONSE
{
  "id": 0,
  "kind": "slack",
  "config": null,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "errors": "string",
  "display_name": "string"
}

Retrieve integrations retrieve

Required API key scopes

integration:read

Path parameters

  • id
    integer
  • project_id
    string

Response


Example request

GET /api/projects/:project_id/integrations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/integrations/:id/

Example response

Status 200
RESPONSE
{
  "id": 0,
  "kind": "slack",
  "config": null,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "errors": "string",
  "display_name": "string"
}

Delete integrations destroy

Required API key scopes

integration:write

Path parameters

  • id
    integer
  • project_id
    string

Example request

DELETE /api/projects/:project_id/integrations/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/integrations/:id/

Example response

Status 204 No response body

Retrieve integrations channels retrieve

Path parameters

  • id
    integer
  • project_id
    string

Example request

GET /api/projects/:project_id/integrations/:id/channels
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/integrations/:id/channels/

Example response

Status 200 No response body

List all integrations clickup lists retrieve

Path parameters

  • id
    integer
  • project_id
    string

Example request

GET /api/projects/:project_id/integrations/:id/clickup_lists
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/integrations/:id/clickup_lists/

Example response

Status 200 No response body

Retrieve integrations clickup spaces retrieve

Path parameters

  • id
    integer
  • project_id
    string

Example request

GET /api/projects/:project_id/integrations/:id/clickup_spaces
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/integrations/:id/clickup_spaces/

Example response

Status 200 No response body
Next page →

Community questions

Questions about this page? or post a community question.