---
title: "surveyFormDefinition.list"
method: POST
path: "/surveyFormDefinition.list"
tags: ["Survey Form Definition"]
---

# surveyFormDefinition.list

`POST /surveyFormDefinition.list`

Lists all survey form definitions.

See the [Pagination and Incremental Synchronization](/docs/pagination-and-incremental-sync) guide for detailed usage examples.

**Requires the [`hiringProcessMetadataRead`](authentication#permissions-surveyformdefinitionlist) permission.**

## Request body

- SurveyFormDefinitionListRequest
  - `cursor` string, nullable — The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.
  - `syncToken` string, nullable — A sync token to retrieve only survey form definitions updated since the last sync. Obtained from a previous list response.
  - `limit` integer, nullable — The maximum number of survey form definitions to return per page.

## Response `200`

Responses from the surveyFormDefinition.list endpoint

- union
  - SurveyFormDefinitionListSuccessResponse
    - `success` true, required
    - `results` SurveyFormDefinition[], required
      - `id` string, uuid, required — The unique identifier for the survey form definition
      - `title` string, required — The title of the survey form definition
      - `isArchived` boolean, required — Whether the survey form definition is archived
      - `formDefinition` FormDefinition, required
        - `sections` FormDefinitionSection[], required — The sections in the form definition
          - `title` string, nullable — The section title
          - `descriptionHtml` string, nullable — The section description formatted as HTML
          - `descriptionPlain` string, nullable — The section description as plain text
          - `fields` FormDefinitionFieldEntry[], required — The fields in this form section
            - `isRequired` boolean, required — Whether this form field is required
            - `descriptionHtml` string, nullable — The field description formatted as HTML
            - `descriptionPlain` string, nullable — The field description as plain text
            - `field` FormDefinitionField, required
              - …
      - `surveyType` 'EEOC' | 'Diversity' | 'CandidateExperience' | 'CandidateDataConsent' | 'Questionnaire' | 'QualityOfHire' | 'HiringManagerExperience', required — The type of survey
    - `nextCursor` string — Cursor for the next page of results, if available
    - `moreDataAvailable` boolean — Whether more data is available beyond this page
    - `syncToken` string — Sync token to use for future incremental syncs. Only present on the last page.
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)