---
title: "List PostHog survey definitions"
method: GET
path: "/v1/projects/{project_id}/surveys"
tags: ["Surveys"]
---

# List PostHog survey definitions

`GET /v1/projects/{project_id}/surveys`

## Request

- Base URL: `https://api.agentry.sh`
- URL: `https://api.agentry.sh/v1/projects/{project_id}/surveys`
- Auth: HTTP bearer

Reads bounded, typed survey configuration from PostHog. A definition does not by itself prove that application source rendered the survey at the intended business boundary.

## Path parameters

- `project_id` string, required

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

OK

- PosthogSurveyListResponse
  - `surveys` PosthogSurvey[], required
    - `id` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `type` string, nullable, required
    - `schedule` string, nullable, required
    - `archived` boolean, nullable, required
    - `start_date` string, nullable, required
    - `end_date` string, nullable, required
    - `created_at` string, nullable, required
    - `responses_limit` number, nullable, required
    - `iteration_count` number, nullable, required
    - `iteration_frequency_days` number, nullable, required
    - `current_iteration` number, nullable, required
    - `enable_partial_responses` boolean, nullable, required
    - `base_language` string, nullable, required
    - `linked_feature_flag` object, nullable, required
      - `id` union, required
        - integer
        - string
      - `key` string, nullable, required
    - `questions` PosthogSurveyQuestion[], required
      - `id` string, nullable, required
      - `type` string, nullable, required
      - `question` string, nullable, required
      - `description` string, nullable, required
      - `optional` boolean, nullable, required
      - `choices` string[], required
      - `scale` number, nullable, required
      - `lower_bound_label` string, nullable, required
      - `upper_bound_label` string, nullable, required
      - `is_nps_question` boolean, nullable, required
  - `page` PosthogResourcePage, required
    - `limit` integer, required
    - `offset` integer, required
    - `has_more` boolean, required
    - `next_offset` integer, nullable, required
  - `freshness` PosthogResourceFreshness, required
    - `source` 'customer_posthog_cloud_api', required
    - `consistency` 'provider_read', required
    - `queried_at` string, date-time, required
    - `status` 'complete_for_query_time', required
  - `data_boundary` PosthogResourceDataBoundary, required
    - `upstream_source` 'customer_posthog_cloud', required
    - `raw_event_stream_retained` false, required
    - `resource_snapshot_retained` false, required
    - `session_recording_content_returned` false, required
    - `provider_mutations_authorized` false, required
  - `next_action` string, required

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/agentry/apis/agentry-api.md) · [All operations](https://skmtc.dev/agentry/apis/agentry-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentry/apis/agentry-api/revisions/abdecddf009f?raw)
