Environments-15
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
Create environments persisted folder
Required API key scopes
persisted_folder:write
Path parameters
- project_idstring
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
- type
- protocolstring
- pathstring
Response
Request
POST
/api /environments /:project_id /persisted_folder
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/environments/:project_id/persisted_folder/\-d type=undefined
Response
Status 201
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","type": "home","protocol": "string","path": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Create environments persisted folder
Required API key scopes
persisted_folder:write
Path parameters
- project_idstring
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
- type
- protocolstring
- pathstring
Response
Request
POST
/api /environments /:project_id /persisted_folder
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/environments/:project_id/persisted_folder/\-d type=undefined
Response
Status 201
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","type": "home","protocol": "string","path": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Retrieve environments persisted folder
Required API key scopes
persisted_folder:read
Path parameters
- idstring
A UUID string identifying this Persisted Folder.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Request
GET
/api /environments /:project_id /persisted_folder /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persisted_folder/:id/
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","type": "home","protocol": "string","path": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Retrieve environments persisted folder
Required API key scopes
persisted_folder:read
Path parameters
- idstring
A UUID string identifying this Persisted Folder.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Request
GET
/api /environments /:project_id /persisted_folder /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persisted_folder/:id/
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","type": "home","protocol": "string","path": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Update environments persisted folder
Required API key scopes
persisted_folder:write
Path parameters
- idstring
A UUID string identifying this Persisted Folder.
- project_idstring
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
- type
- protocolstring
- pathstring
Response
Request
PATCH
/api /environments /:project_id /persisted_folder /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persisted_folder/:id/\-d type=undefined
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","type": "home","protocol": "string","path": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Update environments persisted folder
Required API key scopes
persisted_folder:write
Path parameters
- idstring
A UUID string identifying this Persisted Folder.
- project_idstring
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
- type
- protocolstring
- pathstring
Response
Request
PATCH
/api /environments /:project_id /persisted_folder /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persisted_folder/:id/\-d type=undefined
Response
Status 200
{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08","type": "home","protocol": "string","path": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Delete environments persisted folder
Required API key scopes
persisted_folder:write
Path parameters
- idstring
A UUID string identifying this Persisted Folder.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request
DELETE
/api /environments /:project_id /persisted_folder /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persisted_folder/:id/
Response
Status 204 No response body
Delete environments persisted folder
Required API key scopes
persisted_folder:write
Path parameters
- idstring
A UUID string identifying this Persisted Folder.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Request
DELETE
/api /environments /:project_id /persisted_folder /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persisted_folder/:id/
Response
Status 204 No response body
List all environments persons
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set
and $unset
properties, or one of our SDKs.
Required API key scopes
person:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- distinct_idstring
Filter list by distinct id.
- emailstring
Filter persons by email (exact match)
- formatstringOne of:
"csv"
"json"
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- propertiesarray
Filter Persons by person properties.
- searchstring
Search persons, either by email (full text search) or distinct_id (exact match).
Response
Request
GET
/api /environments /:project_id /persons
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/
Response
Status 200
{"next": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100","previous": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100","count": 400,"results": [{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}]}
List all environments persons
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set
and $unset
properties, or one of our SDKs.
Required API key scopes
person:read
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- distinct_idstring
Filter list by distinct id.
- emailstring
Filter persons by email (exact match)
- formatstringOne of:
"csv"
"json"
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- propertiesarray
Filter Persons by person properties.
- searchstring
Search persons, either by email (full text search) or distinct_id (exact match).
Response
Request
GET
/api /environments /:project_id /persons
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/
Response
Status 200
{"next": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100","previous": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100","count": 400,"results": [{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}]}
Retrieve environments persons
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set
and $unset
properties, or one of our SDKs.
Required API key scopes
person:read
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api /environments /:project_id /persons /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/
Response
Status 200
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve environments persons
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set
and $unset
properties, or one of our SDKs.
Required API key scopes
person:read
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api /environments /:project_id /persons /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/
Response
Status 200
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Update environments persons
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set
and $unset
properties, or one of our SDKs.
Required API key scopes
person:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- formatstringOne of:
"csv"
"json"
Request parameters
- properties
Response
Request
PATCH
/api /environments /:project_id /persons /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/\-d name="string"
Response
Status 200
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Update environments persons
This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set
and $unset
properties, or one of our SDKs.
Required API key scopes
person:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- formatstringOne of:
"csv"
"json"
Request parameters
- properties
Response
Request
PATCH
/api /environments /:project_id /persons /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/\-d name="string"
Response
Status 200
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Delete environments persons
Use this endpoint to delete individual persons. For bulk deletion, use the bulk_delete endpoint instead.
Required API key scopes
person:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- delete_eventsboolean
If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday
- formatstringOne of:
"csv"
"json"
Request
DELETE
/api /environments /:project_id /persons /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/
Response
Status 204 No response body
Delete environments persons
Use this endpoint to delete individual persons. For bulk deletion, use the bulk_delete endpoint instead.
Required API key scopes
person:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Query parameters
- delete_eventsboolean
If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday
- formatstringOne of:
"csv"
"json"
Request
DELETE
/api /environments /:project_id /persons /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/