Persons
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all persons
Path Parameters
- project_idstring
Query Parameters
- distinct_idinteger
- emailstring
- formatstringOne of:
"csv"
"json"
- limitinteger
- offsetinteger
- propertiesarray
- searchstring
Response
Request
GET
/api/projects/:project_id/persons/
Response
{"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","results": [{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}]}
Create persons
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- propertiesobject
Response
Request
POST
/api/projects/:project_id/persons/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons
Path Parameters
- idinteger
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/:id/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Update persons
Path Parameters
- idinteger
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- propertiesobject
Response
Request
PATCH
/api/projects/:project_id/persons/:id/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Delete persons
Path Parameters
- idinteger
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request
DELETE
/api/projects/:project_id/persons/:id/
Response
No responseRetrieve persons activity retrieve
Path Parameters
- idinteger
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/:id/activity/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Create persons delete property
Path Parameters
- idinteger
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- propertiesobject
Response
Request
POST
/api/projects/:project_id/persons/:id/delete_property/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Create persons merge
Path Parameters
- idinteger
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- propertiesobject
Response
Request
POST
/api/projects/:project_id/persons/:id/merge/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Create persons split
Path Parameters
- idinteger
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- propertiesobject
Response
Request
POST
/api/projects/:project_id/persons/:id/split/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons activity
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/activity/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons cohorts
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/cohorts/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons funnel
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/funnel/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Create persons funnel
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- propertiesobject
Response
Request
POST
/api/projects/:project_id/persons/funnel/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons funnel correlation
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/funnel/correlation/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Create persons funnel correlation
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- propertiesobject
Response
Request
POST
/api/projects/:project_id/persons/funnel/correlation/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons lifecycle
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/lifecycle/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons path
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/path/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Create persons path
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Request Parameters
- propertiesobject
Response
Request
POST
/api/projects/:project_id/persons/path/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons properties
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/properties/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons retention
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/retention/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons stickiness
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/stickiness/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve persons values
Path Parameters
- project_idstring
Query Parameters
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api/projects/:project_id/persons/values/
Response
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": {"property1": null,"property2": null},"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}