Organizations-2 API Reference

Organizations-2

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

Pause a BatchExport.

Endpoints

`POST`	`/api/organizations/:organization_id/batch_exports/:id/pause/`
`POST`	`/api/organizations/:organization_id/batch_exports/:id/unpause/`
`GET`	`/api/organizations/:organization_id/domains/`
`POST`	`/api/organizations/:organization_id/domains/`
`GET`	`/api/organizations/:organization_id/domains/:id/`
`PATCH`	`/api/organizations/:organization_id/domains/:id/`
`DELETE`	`/api/organizations/:organization_id/domains/:id/`
`POST`	`/api/organizations/:organization_id/domains/:id/verify/`
`GET`	`/api/organizations/:organization_id/invites/`
`POST`	`/api/organizations/:organization_id/invites/`
`DELETE`	`/api/organizations/:organization_id/invites/:id/`
`POST`	`/api/organizations/:organization_id/invites/bulk/`
`GET`	`/api/organizations/:organization_id/members/`
`PATCH`	`/api/organizations/:organization_id/members/:user__uuid/`
`DELETE`	`/api/organizations/:organization_id/members/:user__uuid/`
`GET`	`/api/organizations/:organization_id/projects/`
`POST`	`/api/organizations/:organization_id/projects/`
`GET`	`/api/organizations/:organization_id/projects/:id/`

Create batch exports pause

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string

Request

POST /api/organizations/:organization_id/batch_exports/:id/pause

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/batch_exports/:id/pause/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200 No response body

Create batch exports unpause

Unpause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
organization_id
string

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string

Request

POST /api/organizations/:organization_id/batch_exports/:id/unpause

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/batch_exports/:id/unpause/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200 No response body

List all domains

Required API key scopes

organization: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/domains

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "domain": "string",
      "is_verified": true,
      "verified_at": "2019-08-24T14:15:22Z",
      "verification_challenge": "string",
      "jit_provisioning_enabled": true,
      "sso_enforcement": "string",
      "has_saml": true,
      "saml_entity_id": "string",
      "saml_acs_url": "string",
      "saml_x509_cert": "string"
    }
  ]
}

Create domains

Required API key scopes

organization:write

Path parameters

organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string

Response

Request

POST /api/organizations/:organization_id/domains

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/domains/\
	-d domain="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string"
}

Retrieve domains

Required API key scopes

organization:read

Path parameters

id
string
A UUID string identifying this domain.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/domains/: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/domains/:id/

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string"
}

Update domains

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this domain.
organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string

Response

Request

PATCH /api/organizations/:organization_id/domains/: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/domains/:id/\
	-d domain="string"

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "domain": "string",
  "is_verified": true,
  "verified_at": "2019-08-24T14:15:22Z",
  "verification_challenge": "string",
  "jit_provisioning_enabled": true,
  "sso_enforcement": "string",
  "has_saml": true,
  "saml_entity_id": "string",
  "saml_acs_url": "string",
  "saml_x509_cert": "string"
}

Delete domains

Required API key scopes

organization:write

Path parameters

id
string
A UUID string identifying this domain.
organization_id
string

Request

DELETE /api/organizations/:organization_id/domains/: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/domains/:id/

Response

Status 204 No response body

Create domains verify

Path parameters

id
string
A UUID string identifying this domain.
organization_id
string

Request parameters

domain
string
jit_provisioning_enabled
boolean
sso_enforcement
string
saml_entity_id
string
saml_acs_url
string
saml_x509_cert
string

Request

POST /api/organizations/:organization_id/domains/:id/verify

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/domains/:id/verify/\
	-d domain="string"

Response

Status 200 No response body

List all invites

Required API key scopes

organization_member: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/invites

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "target_email": "user@example.com",
      "first_name": "string",
      "emailing_attempt_made": true,
      "level": 1,
      "is_expired": true,
      "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
        }
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "message": "string",
      "private_project_access": null,
      "send_email": true,
      "combine_pending_invites": false
    }
  ]
}

Create invites

Required API key scopes

organization_member:write

Path parameters

organization_id
string

Request parameters

target_email
string
first_name
string
level
message
string
private_project_access
List of team IDs and corresponding access levels to private projects.
send_email
boolean
Default:
combine_pending_invites
boolean

Response

Request

POST /api/organizations/:organization_id/invites

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/invites/\
	-d target_email="string"

Response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "target_email": "user@example.com",
  "first_name": "string",
  "emailing_attempt_made": true,
  "level": 1,
  "is_expired": true,
  "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
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "message": "string",
  "private_project_access": null,
  "send_email": true,
  "combine_pending_invites": false
}

Delete invites

Required API key scopes

organization_member:write

Path parameters

id
string
A UUID string identifying this organization invite.
organization_id
string

Request

DELETE /api/organizations/:organization_id/invites/: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/invites/:id/

Response

Status 204 No response body

Create invites bulk

Required API key scopes

organization_member:write

Path parameters

organization_id
string

Request parameters

target_email
string
first_name
string
level
message
string
private_project_access
List of team IDs and corresponding access levels to private projects.
send_email
boolean
Default:
combine_pending_invites
boolean

Request

POST /api/organizations/:organization_id/invites/bulk

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/invites/bulk/\
	-d target_email="string"

Response

Status 200 No response body

List all members

Required API key scopes

organization_member: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/members

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "user": {
        "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
        }
      },
      "level": 1,
      "joined_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "is_2fa_enabled": true,
      "has_social_auth": true,
      "last_login": "2019-08-24T14:15:22Z"
    }
  ]
}

Update members

Required API key scopes

organization_member:write

Path parameters

organization_id
string
user__uuid
string

Request parameters

level

Response

Request

PATCH /api/organizations/:organization_id/members/:user__uuid

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/members/:user__uuid/\
	-d user=undefined

Response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": {
    "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
    }
  },
  "level": 1,
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "is_2fa_enabled": true,
  "has_social_auth": true,
  "last_login": "2019-08-24T14:15:22Z"
}

Delete members

Required API key scopes

organization_member:write

Path parameters

organization_id
string
user__uuid
string

Request

DELETE /api/organizations/:organization_id/members/:user__uuid

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/members/:user__uuid/

Response

Status 204 No response body

Retrieve list

Projects for the current organization.

Required API key scopes

project: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/projects

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

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,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
      "api_token": "string",
      "name": "string",
      "completed_snippet_onboarding": true,
      "has_completed_onboarding_for": null,
      "ingested_event": true,
      "is_demo": true,
      "timezone": "Africa/Abidjan",
      "access_control": true
    }
  ]
}

Create create

Projects for the current organization.

Required API key scopes

project:write

Path parameters

organization_id
string

Request parameters

name
string
product_description
string
app_urls
array
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_replay_config
survey_config
access_control
boolean
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean

Response

Request

POST /api/organizations/:organization_id/projects

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/projects/\
	-d organization="string"

Response

Status 201

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_web_vitals_allowed_metrics": null,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 15000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string"
}

Retrieve retrieve

Projects for the current organization.

Required API key scopes

project:read

Path parameters

id
integer
A unique value identifying this project.
organization_id
string

Response

Request

GET /api/organizations/:organization_id/projects/: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/projects/:id/

Response

Status 200

RESPONSE

{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_web_vitals_allowed_metrics": null,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 15000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": "string",
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": "string",
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": "string"
}