provider surveys GET /api/projects/{project_id}/surveys/
@utdk/posthog /api/projects/{project_id}/surveys/
surveys_list
archived query
boolean
ids query
Multiple values may be separated by commas.
array
limit query
Number of results to return per page.
integer
offset query
The initial index from which to return the results.
integer
project_id path required
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
string
search query
Match against survey `name` and `description`. Returns exact (case-insensitive substring) matches only; if no exact match exists, returns similar (fuzzy trigram — typos, prefix-as-you-type) matches instead. Each result's `search_match_type` is `exact` or `similar`.
string
type query
* `popover` - popover * `widget` - widget * `external_survey` - external survey * `api` - api
enum: api, external_survey, popover, widget

Try it

Authentication
Configure credentials for PostHog API
surveysList
GET/api/projects/{project_id}/surveys/

Parameters

required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Multiple values may be separated by commas.

Number of results to return per page.

The initial index from which to return the results.

Match against survey `name` and `description`. Returns exact (case-insensitive substring) matches only; if no exact match exists, returns similar (fuzzy trigram — typos, prefix-as-you-type) matches instead. Each result's `search_match_type` is `exact` or `similar`.

* `popover` - popover * `widget` - widget * `external_survey` - external survey * `api` - api

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import posthog from '@utdk/posthog';

await posthog.surveysList()