Organizations-3 API Reference

Organizations-3

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

Endpoints

`PATCH`	`/api/organizations/:organization_id/pipeline_destinations/:id/`
`DELETE`	`/api/organizations/:organization_id/pipeline_destinations/:id/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/:id/check_for_updates/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/:id/source/`
`PATCH`	`/api/organizations/:organization_id/pipeline_destinations/:id/update_source/`
`POST`	`/api/organizations/:organization_id/pipeline_destinations/:id/upgrade/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/activity/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/exports_unsubscribe_configs/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/repository/`
`GET`	`/api/organizations/:organization_id/pipeline_destinations/unused/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/`
`POST`	`/api/organizations/:organization_id/pipeline_frontend_apps/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/`
`PATCH`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/`
`DELETE`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/check_for_updates/`
`GET`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/source/`
`PATCH`	`/api/organizations/:organization_id/pipeline_frontend_apps/:id/update_source/`

Update pipeline destinations

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_destinations/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_destinations/:id/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null,
  "hog_function_migration_available": "string"
}

Delete pipeline destinations

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

DELETE /api/organizations/:organization_id/pipeline_destinations/:id

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

Response

Status 204 No response body

Retrieve pipeline destinations check for updates

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

GET /api/organizations/:organization_id/pipeline_destinations/:id/check_for_updates

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_destinations/:id/check_for_updates/

Response

Status 200 No response body

Retrieve pipeline destinations source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

GET /api/organizations/:organization_id/pipeline_destinations/:id/source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_destinations/:id/source/

Response

Status 200 No response body

Update pipeline destinations update source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Request

PATCH /api/organizations/:organization_id/pipeline_destinations/:id/update_source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_destinations/:id/update_source/\
	-d plugin_type=undefined

Response

Status 200 No response body

Create pipeline destinations upgrade

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Request

POST /api/organizations/:organization_id/pipeline_destinations/:id/upgrade

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/organizations/:organization_id/pipeline_destinations/:id/upgrade/\
	-d plugin_type=undefined

Response

Status 200 No response body

Retrieve pipeline destinations activity

Path parameters

organization_id
string

Request

GET /api/organizations/:organization_id/pipeline_destinations/activity

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_destinations/activity/

Response

Status 200 No response body

Retrieve pipeline destinations exports unsubscribe configs

Path parameters

organization_id
string

Request

GET /api/organizations/:organization_id/pipeline_destinations/exports_unsubscribe_configs

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_destinations/exports_unsubscribe_configs/

Response

Status 200 No response body

Retrieve pipeline destinations repository

Path parameters

organization_id
string

Request

GET /api/organizations/:organization_id/pipeline_destinations/repository

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_destinations/repository/

Response

Status 200 No response body

Retrieve pipeline destinations unused

Path parameters

organization_id
string

Request

GET /api/organizations/:organization_id/pipeline_destinations/unused

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_destinations/unused/

Response

Status 200 No response body

List all pipeline frontend apps

Required API key scopes

plugin:read

Path parameters

organization_id
string

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_frontend_apps/

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,
      "plugin_type": "local",
      "name": "string",
      "description": "string",
      "url": "string",
      "icon": "string",
      "config_schema": null,
      "tag": "string",
      "latest_tag": "string",
      "is_global": true,
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
      "organization_name": "string",
      "capabilities": null,
      "metrics": null,
      "public_jobs": null,
      "hog_function_migration_available": "string"
    }
  ]
}

Create pipeline frontend apps

Required API key scopes

plugin:write

Path parameters

organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

POST /api/organizations/:organization_id/pipeline_frontend_apps

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/organizations/:organization_id/pipeline_frontend_apps/\
	-d plugin_type=undefined

Response

Status 201

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null,
  "hog_function_migration_available": "string"
}

Retrieve pipeline frontend apps

Required API key scopes

plugin:read

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_frontend_apps/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null,
  "hog_function_migration_available": "string"
}

Update pipeline frontend apps

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Response

Request

PATCH /api/organizations/:organization_id/pipeline_frontend_apps/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_frontend_apps/:id/\
	-d plugin_type=undefined

Response

Status 200

RESPONSE

{
  "id": 0,
  "plugin_type": "local",
  "name": "string",
  "description": "string",
  "url": "string",
  "icon": "string",
  "config_schema": null,
  "tag": "string",
  "latest_tag": "string",
  "is_global": true,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "organization_name": "string",
  "capabilities": null,
  "metrics": null,
  "public_jobs": null,
  "hog_function_migration_available": "string"
}

Delete pipeline frontend apps

Required API key scopes

plugin:write

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

DELETE /api/organizations/:organization_id/pipeline_frontend_apps/:id

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

Response

Status 204 No response body

Retrieve pipeline frontend apps check for updates

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/:id/check_for_updates

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_frontend_apps/:id/check_for_updates/

Response

Status 200 No response body

Retrieve pipeline frontend apps source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request

GET /api/organizations/:organization_id/pipeline_frontend_apps/:id/source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_frontend_apps/:id/source/

Response

Status 200 No response body

Update pipeline frontend apps update source

Path parameters

id
integer
A unique integer value identifying this plugin.
organization_id
string

Request parameters

plugin_type
name
string
description
string
icon
string
config_schema
tag
string
is_global
boolean
capabilities
metrics
public_jobs

Request

PATCH /api/organizations/:organization_id/pipeline_frontend_apps/:id/update_source

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/organizations/:organization_id/pipeline_frontend_apps/:id/update_source/\
	-d plugin_type=undefined