User API Reference

User

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

Endpoints

`GET`
`POST`
`GET`
`PATCH`
`DELETE`

List all user interviews

Required API key scopes

user_interview_DO_NOT_USE:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:project_id/user_interviews
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/user_interviews/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/user_interviews/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "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"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "interviewee_emails": [
        "string"
      ],
      "transcript": "string",
      "summary": "string",
      "audio": "http://example.com"
    }
  ]
}

Create user interviews

Required API key scopes

user_interview_DO_NOT_USE:write

Path parameters

project_id
string

Request parameters

interviewee_emails
array
summary
string
audio
string

Response

Example request

POST /api/environments/:project_id/user_interviews
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/user_interviews/\
	-d audio="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/user_interviews/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"audio": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "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"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "interviewee_emails": [
    "string"
  ],
  "transcript": "string",
  "summary": "string",
  "audio": "http://example.com"
}

Retrieve user interviews

Required API key scopes

user_interview_DO_NOT_USE:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/environments/:project_id/user_interviews/: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/user_interviews/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/user_interviews/{user_interview_id}/".format(
        project_id=project_id,
		user_interview_id="<the user interview id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "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"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "interviewee_emails": [
    "string"
  ],
  "transcript": "string",
  "summary": "string",
  "audio": "http://example.com"
}

Update user interviews

Required API key scopes

user_interview_DO_NOT_USE:write

Path parameters

id
string
project_id
string

Request parameters

interviewee_emails
array
summary
string
audio
string

Response

Example request

PATCH /api/environments/:project_id/user_interviews/: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/user_interviews/:id/\
	-d created_by=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/user_interviews/{user_interview_id}/".format(
        project_id=project_id,
		user_interview_id="<the user interview id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "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"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "interviewee_emails": [
    "string"
  ],
  "transcript": "string",
  "summary": "string",
  "audio": "http://example.com"
}

Delete user interviews

Required API key scopes

user_interview_DO_NOT_USE:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/environments/:project_id/user_interviews/: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/user_interviews/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/user_interviews/{user_interview_id}/".format(
        project_id=project_id,
		user_interview_id="<the user interview id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

User

Endpoints

List all user interviews

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create user interviews

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve user interviews

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update user interviews

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete user interviews

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions