> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/reference/surveys-and-custom-fields/surveys.md).
# Surveys
## List All Surveys
> Returns a list of surveys for the program. Supports filtering by name,\
> status, partner IDs, and publisher groups.\
> \
> Deleted (archived) surveys are \*\*not\*\* included in the results.\
> \
> {% hint style="success" %}\
> \*\*Note:\*\* When using the \`PartnerIds\` and \`PublisherGroups\` parameters,\
> the API returns surveys that the specified partner or group is permitted\
> to access, regardless of whether those publishers have actually\
> responded to the survey.\
> {% endhint %}
```json
{"openapi":"3.1.0","info":{"title":"Surveys","version":"v14"},"tags":[{"name":"Surveys"}],"servers":[{"url":"https://api.impact.com","description":"impact.com API"}],"paths":{"/Advertisers/{AccountSid}/Programs/{ProgramId}/Surveys":{"get":{"tags":["Surveys"],"operationId":"listSurveys","summary":"List All Surveys","description":"Returns a list of surveys for the program. Supports filtering by name,\nstatus, partner IDs, and publisher groups.\n\nDeleted (archived) surveys are **not** included in the results.\n\n{% hint style=\"success\" %}\n**Note:** When using the `PartnerIds` and `PublisherGroups` parameters,\nthe API returns surveys that the specified partner or group is permitted\nto access, regardless of whether those publishers have actually\nresponded to the survey.\n{% endhint %}\n","parameters":[{"name":"Query","in":"query","required":false,"description":"Filter surveys by name.","schema":{"type":"string"}},{"name":"Status","in":"query","required":false,"description":"Filter by survey status.","schema":{"type":"string","enum":["Active","Upcoming","Expired"]}},{"name":"PartnerIds","in":"query","required":false,"description":"Filter surveys whose access is restricted to one or more of the given partner IDs. Does not filter by which partners responded.\n","schema":{"type":"array","items":{"type":"integer","format":"int64"}},"style":"form","explode":true},{"name":"PublisherGroups","in":"query","required":false,"description":"Filter to surveys whose access is restricted to one or more of the given publisher group names. Does not filter by which partners responded.\n","schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}],"responses":{"200":{"description":"A list of surveys.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyListResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"schemas":{"SurveyListResponse":{"type":"object","properties":{"Surveys":{"type":"array","items":{"$ref":"#/components/schemas/SurveySummary"}}}},"SurveySummary":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"StartDate":{"type":"string","format":"date-time"},"EndDate":{"type":["string","null"],"format":"date-time"},"Status":{"type":"string","enum":["Active","Upcoming","Expired"],"description":"Automatically calculated from the date range. Active = no restrictions or currently within range; Upcoming = start date in the future; Expired = end date in the past.\n"},"CoverImageUrl":{"type":"string"},"QuestionsCount":{"type":"integer"},"ResponsesCount":{"type":"integer"},"CreatedDate":{"type":"string","format":"date-time"},"UpdatedDate":{"type":"string","format":"date-time"}}}},"responses":{"BadRequest":{"description":"Bad request — invalid request or validation failure."},"NotFound":{"description":"Resource not found."},"ServerError":{"description":"Internal server error."}}}}
```
## Create a Survey
> Creates a survey. Requires a name and a list of questions. Optional\
> fields include dates, timezone, cover image URL, and partner/group\
> restrictions.\
> \
> {% hint style="warning" %}\
> \*\*Warning:\*\* Only surveys with no access restrictions and no scheduled\
> dates can be added to your partner sign-up page. If you set\
> \`RestrictToPartners\`, \`RestrictToGroups\`, \`StartDate\`, or \`EndDate\`, the\
> survey can't be selected as a sign-up survey. See\
> \[Add a Survey to the Partner Sign-Up Page]\(
> {% endhint %}
```json
{"openapi":"3.1.0","info":{"title":"Surveys","version":"v14"},"tags":[{"name":"Surveys"}],"servers":[{"url":"https://api.impact.com","description":"impact.com API"}],"paths":{"/Advertisers/{AccountSid}/Programs/{ProgramId}/Surveys":{"post":{"tags":["Surveys"],"operationId":"createSurvey","summary":"Create a Survey","description":"Creates a survey. Requires a name and a list of questions. Optional\nfields include dates, timezone, cover image URL, and partner/group\nrestrictions.\n\n{% hint style=\"warning\" %}\n**Warning:** Only surveys with no access restrictions and no scheduled\ndates can be added to your partner sign-up page. If you set\n`RestrictToPartners`, `RestrictToGroups`, `StartDate`, or `EndDate`, the\nsurvey can't be selected as a sign-up survey. See\n[Add a Survey to the Partner Sign-Up Page](https://help.impact.com/brand/what-would-you-like-to-learn-about/platform-features/reach-out-to-partners/surveys/add-a-survey-to-the-partner-sign-up-page).\n{% endhint %}\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSurveyRequest"}}}},"responses":{"201":{"description":"The created survey.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Survey"}}}},"400":{"description":"Bad request. This can occur when:\n- The Account SID in the path is invalid\n- The survey name is missing\n- No questions are provided\n- A question is missing its question text\n- A question is missing a `CustomFieldId`\n- The same custom field is used on more than one question in the survey\n- A `Timezone` is provided but is not a valid IANA timezone ID\n- A `CoverImageUrl` is provided but its file extension is unsupported\n- The survey name exceeds 255 characters, or a question's text exceeds 191 characters\n"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"schemas":{"CreateSurveyRequest":{"type":"object","required":["Name","Questions"],"properties":{"Name":{"type":"string","maxLength":255,"description":"Name of the survey."},"Description":{"type":"string","description":"Description of the survey."},"StartDate":{"type":"string","format":"date","description":"Start date (ISO 8601)."},"EndDate":{"type":"string","format":"date","description":"End date (ISO 8601)."},"Timezone":{"type":"string","description":"IANA timezone ID (e.g. America/New_York, UTC). Stored for reference.\n"},"CoverImageUrl":{"type":"string","description":"URL for the survey cover image. If not provided, the brand's logo is used. Supported file extensions: gif, jpg, png, and webp.\n"},"RestrictToPartners":{"type":"array","uniqueItems":true,"description":"Set of partner IDs to restrict the survey to.","items":{"type":"integer","format":"int64"}},"RestrictToGroups":{"type":"array","uniqueItems":true,"description":"Set of group names to restrict the survey to. Group names are case-sensitive.\n","items":{"type":"string"}},"Questions":{"type":"array","minItems":1,"description":"List of questions to create. At least one question is required to create a survey.\n","items":{"$ref":"#/components/schemas/CreateQuestion"}}}},"CreateQuestion":{"type":"object","required":["Question","CustomFieldId"],"properties":{"Question":{"type":"string","maxLength":191,"description":"The question text."},"CustomFieldId":{"type":"integer","format":"int64","description":"ID of the custom field linked to this question."},"ResponseRequired":{"type":"boolean","default":false,"description":"Whether a response is required."},"ResponseEditable":{"type":"boolean","default":false,"description":"Whether the response is editable."}}},"Survey":{"allOf":[{"$ref":"#/components/schemas/SurveySummary"},{"type":"object","properties":{"Questions":{"type":"array","items":{"$ref":"#/components/schemas/Question"}}}}]},"SurveySummary":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"StartDate":{"type":"string","format":"date-time"},"EndDate":{"type":["string","null"],"format":"date-time"},"Status":{"type":"string","enum":["Active","Upcoming","Expired"],"description":"Automatically calculated from the date range. Active = no restrictions or currently within range; Upcoming = start date in the future; Expired = end date in the past.\n"},"CoverImageUrl":{"type":"string"},"QuestionsCount":{"type":"integer"},"ResponsesCount":{"type":"integer"},"CreatedDate":{"type":"string","format":"date-time"},"UpdatedDate":{"type":"string","format":"date-time"}}},"Question":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Question":{"type":"string"},"CustomFieldId":{"type":"integer","format":"int64"},"ResponseRequired":{"type":"boolean"},"ResponseEditable":{"type":"boolean"},"Rank":{"type":"integer"},"CustomField":{"$ref":"#/components/schemas/CustomField"}}},"CustomField":{"type":"object","description":"A custom field that defines the data collection type for a survey question.\n","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"DisplayType":{"type":"string","description":"The display type.","enum":["Paragraph","Multi-select","Dropdown list","Single-select","Date picker","Number","File"]},"Enumerations":{"type":"array","items":{"$ref":"#/components/schemas/Enumeration"}}}},"Enumeration":{"type":"object","description":"An allowed value for a selection-based custom field.","properties":{"Id":{"type":"integer","format":"int64"},"Value":{"type":"string"}}}},"responses":{"NotFound":{"description":"Resource not found."},"ServerError":{"description":"Internal server error."}}}}
```
## Get a Survey
> Returns full survey details, including all questions and their linked custom field information.
```json
{"openapi":"3.1.0","info":{"title":"Surveys","version":"v14"},"tags":[{"name":"Surveys"}],"servers":[{"url":"https://api.impact.com","description":"impact.com API"}],"paths":{"/Advertisers/{AccountSid}/Programs/{ProgramId}/Surveys/{SurveyId}":{"get":{"tags":["Surveys"],"operationId":"getSurvey","summary":"Get a Survey","description":"Returns full survey details, including all questions and their linked custom field information.\n","responses":{"200":{"description":"The requested survey.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Survey"}}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"schemas":{"Survey":{"allOf":[{"$ref":"#/components/schemas/SurveySummary"},{"type":"object","properties":{"Questions":{"type":"array","items":{"$ref":"#/components/schemas/Question"}}}}]},"SurveySummary":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"StartDate":{"type":"string","format":"date-time"},"EndDate":{"type":["string","null"],"format":"date-time"},"Status":{"type":"string","enum":["Active","Upcoming","Expired"],"description":"Automatically calculated from the date range. Active = no restrictions or currently within range; Upcoming = start date in the future; Expired = end date in the past.\n"},"CoverImageUrl":{"type":"string"},"QuestionsCount":{"type":"integer"},"ResponsesCount":{"type":"integer"},"CreatedDate":{"type":"string","format":"date-time"},"UpdatedDate":{"type":"string","format":"date-time"}}},"Question":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Question":{"type":"string"},"CustomFieldId":{"type":"integer","format":"int64"},"ResponseRequired":{"type":"boolean"},"ResponseEditable":{"type":"boolean"},"Rank":{"type":"integer"},"CustomField":{"$ref":"#/components/schemas/CustomField"}}},"CustomField":{"type":"object","description":"A custom field that defines the data collection type for a survey question.\n","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"DisplayType":{"type":"string","description":"The display type.","enum":["Paragraph","Multi-select","Dropdown list","Single-select","Date picker","Number","File"]},"Enumerations":{"type":"array","items":{"$ref":"#/components/schemas/Enumeration"}}}},"Enumeration":{"type":"object","description":"An allowed value for a selection-based custom field.","properties":{"Id":{"type":"integer","format":"int64"},"Value":{"type":"string"}}}},"responses":{"NotFound":{"description":"Resource not found."},"ServerError":{"description":"Internal server error."}}}}
```
## Delete a Survey
> Archives the survey and its questions.
```json
{"openapi":"3.1.0","info":{"title":"Surveys","version":"v14"},"tags":[{"name":"Surveys"}],"servers":[{"url":"https://api.impact.com","description":"impact.com API"}],"paths":{"/Advertisers/{AccountSid}/Programs/{ProgramId}/Surveys/{SurveyId}":{"delete":{"tags":["Surveys"],"operationId":"deleteSurvey","summary":"Delete a Survey","description":"Archives the survey and its questions.","responses":{"200":{"description":"The survey was archived.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResponse"}}}},"404":{"description":"Survey not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"schemas":{"StatusResponse":{"type":"object","properties":{"Status":{"type":"string"}}},"ErrorResponse":{"type":"object","description":"Error envelope returned by custom field write operations.","properties":{"Status":{"type":"string"},"Message":{"type":"string","description":"Human-readable error description."}}}},"responses":{"ServerError":{"description":"Internal server error."}}}}
```
## Update a Survey
> Partially updates a survey. Only the fields provided are updated.\
> Questions with an \`Id\` are updated; questions without an \`Id\` are\
> created.\
> \
> {% hint style="success" %}\
> \*\*Note:\*\* You can only edit a survey if it has not yet recorded any\
> responses. Once a response has been received, the survey can no longer\
> be modified to ensure the integrity of the collected data.\
> {% endhint %}
```json
{"openapi":"3.1.0","info":{"title":"Surveys","version":"v14"},"tags":[{"name":"Surveys"}],"servers":[{"url":"https://api.impact.com","description":"impact.com API"}],"paths":{"/Advertisers/{AccountSid}/Programs/{ProgramId}/Surveys/{SurveyId}":{"patch":{"tags":["Surveys"],"operationId":"updateSurvey","summary":"Update a Survey","description":"Partially updates a survey. Only the fields provided are updated.\nQuestions with an `Id` are updated; questions without an `Id` are\ncreated.\n\n{% hint style=\"success\" %}\n**Note:** You can only edit a survey if it has not yet recorded any\nresponses. Once a response has been received, the survey can no longer\nbe modified to ensure the integrity of the collected data.\n{% endhint %}\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSurveyRequest"}}}},"responses":{"200":{"description":"The updated survey.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Survey"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"schemas":{"UpdateSurveyRequest":{"type":"object","description":"All fields are optional. Only the fields provided are updated.","properties":{"Name":{"type":"string","maxLength":255,"description":"Updated name of the survey."},"Description":{"type":"string","description":"Updated description of the survey."},"StartDate":{"type":"string","format":"date","description":"Updated start date (ISO 8601)."},"EndDate":{"type":"string","format":"date","description":"Updated end date (ISO 8601)."},"Timezone":{"type":"string","description":"IANA timezone ID (e.g. America/New_York, UTC). Stored for reference."},"CoverImageUrl":{"type":"string","description":"Updated cover image URL."},"RestrictToPartners":{"type":"array","uniqueItems":true,"description":"Set of partner IDs to restrict the survey to.","items":{"type":"integer","format":"int64"}},"RestrictToGroups":{"type":"array","uniqueItems":true,"description":"Set of group names to restrict the survey to. Group names are case-sensitive.\n","items":{"type":"string"}},"Questions":{"type":"array","description":"List of questions to create or update.","items":{"$ref":"#/components/schemas/UpdateQuestion"}}}},"UpdateQuestion":{"type":"object","properties":{"Id":{"type":"integer","format":"int64","description":"ID of an existing question to update. Omit to create a new one."},"Question":{"type":"string","maxLength":191,"description":"The question text."},"CustomFieldId":{"type":"integer","format":"int64","description":"ID of the custom field linked to this question."},"ResponseRequired":{"type":"boolean","default":false,"description":"Whether a response is required."},"ResponseEditable":{"type":"boolean","default":false,"description":"Whether the response is editable."}}},"Survey":{"allOf":[{"$ref":"#/components/schemas/SurveySummary"},{"type":"object","properties":{"Questions":{"type":"array","items":{"$ref":"#/components/schemas/Question"}}}}]},"SurveySummary":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"StartDate":{"type":"string","format":"date-time"},"EndDate":{"type":["string","null"],"format":"date-time"},"Status":{"type":"string","enum":["Active","Upcoming","Expired"],"description":"Automatically calculated from the date range. Active = no restrictions or currently within range; Upcoming = start date in the future; Expired = end date in the past.\n"},"CoverImageUrl":{"type":"string"},"QuestionsCount":{"type":"integer"},"ResponsesCount":{"type":"integer"},"CreatedDate":{"type":"string","format":"date-time"},"UpdatedDate":{"type":"string","format":"date-time"}}},"Question":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Question":{"type":"string"},"CustomFieldId":{"type":"integer","format":"int64"},"ResponseRequired":{"type":"boolean"},"ResponseEditable":{"type":"boolean"},"Rank":{"type":"integer"},"CustomField":{"$ref":"#/components/schemas/CustomField"}}},"CustomField":{"type":"object","description":"A custom field that defines the data collection type for a survey question.\n","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"DisplayType":{"type":"string","description":"The display type.","enum":["Paragraph","Multi-select","Dropdown list","Single-select","Date picker","Number","File"]},"Enumerations":{"type":"array","items":{"$ref":"#/components/schemas/Enumeration"}}}},"Enumeration":{"type":"object","description":"An allowed value for a selection-based custom field.","properties":{"Id":{"type":"integer","format":"int64"},"Value":{"type":"string"}}}},"responses":{"BadRequest":{"description":"Bad request — invalid request or validation failure."},"NotFound":{"description":"Resource not found."},"ServerError":{"description":"Internal server error."}}}}
```
## Retrieve Survey Responses
> Returns deduplicated responses, showing only the most recent answer per question per user. Supports filtering by partner ID, question ID, and date range.
```json
{"openapi":"3.1.0","info":{"title":"Surveys","version":"v14"},"tags":[{"name":"Surveys"}],"servers":[{"url":"https://api.impact.com","description":"impact.com API"}],"paths":{"/Advertisers/{AccountSid}/Programs/{ProgramId}/Surveys/{SurveyId}/Responses":{"get":{"tags":["Surveys"],"operationId":"listSurveyResponses","summary":"Retrieve Survey Responses","description":"Returns deduplicated responses, showing only the most recent answer per question per user. Supports filtering by partner ID, question ID, and date range.\n","parameters":[{"name":"PartnerIds","in":"query","required":false,"description":"Filter responses by one or more partner IDs.","schema":{"type":"array","items":{"type":"integer","format":"int64"}},"style":"form","explode":true},{"name":"QuestionIds","in":"query","required":false,"description":"Filter responses by one or more question IDs.","schema":{"type":"array","items":{"type":"integer","format":"int64"}},"style":"form","explode":true},{"name":"DateFrom","in":"query","required":false,"description":"Filter responses from this date (ISO 8601, e.g. 2026-01-01).","schema":{"type":"string","format":"date"}},{"name":"DateTo","in":"query","required":false,"description":"Filter responses up to this date (ISO 8601, e.g. 2026-06-30).","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"A list of survey responses.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyResponseListResponse"}}}},"404":{"$ref":"#/components/responses/NotFound"},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"schemas":{"SurveyResponseListResponse":{"type":"object","properties":{"Responses":{"type":"array","items":{"$ref":"#/components/schemas/SurveyResponse"}}}},"SurveyResponse":{"type":"object","properties":{"Id":{"type":"integer"},"QuestionId":{"type":"integer","format":"int64"},"Question":{"type":"string"},"PartnerId":{"type":"integer","format":"int64"},"PartnerName":{"type":"string"},"UserId":{"type":"integer","format":"int64"},"UserEmail":{"type":"string"},"ResponseValue":{"type":"string","description":"The response value. For enumeration-based custom fields, this is a comma-separated list of enumeration IDs that resolve to display values via the custom field's enumeration list.\n"},"ResponseDate":{"type":"string","format":"date-time"},"CustomFieldId":{"type":"integer","format":"int64"}}}},"responses":{"NotFound":{"description":"Resource not found."},"ServerError":{"description":"Internal server error."}}}}
```
## Upload a Cover Image
> Uploads a cover image for the survey. Uploading a cover image is optional — if no cover image is set, the brand's logo is used.
```json
{"openapi":"3.1.0","info":{"title":"Surveys","version":"v14"},"tags":[{"name":"Surveys"}],"servers":[{"url":"https://api.impact.com","description":"impact.com API"}],"paths":{"/Advertisers/{AccountSid}/Programs/{ProgramId}/Surveys/{SurveyId}/CoverImage":{"post":{"tags":["Surveys"],"operationId":"uploadSurveyCoverImage","summary":"Upload a Cover Image","description":"Uploads a cover image for the survey. Uploading a cover image is optional — if no cover image is set, the brand's logo is used.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["CoverImageFile"],"properties":{"CoverImageFile":{"type":"string","format":"binary","description":"Cover image file. Supported file extensions: .png, .jpg, .jpeg, .gif, .webp. Maximum file size: 20 MB.\n"}}}}}},"responses":{"200":{"description":"Returns the full survey detail with the updated cover image URL (same structure as Get a Survey).\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoverImageUploadResponse"}}}},"400":{"description":"Bad request. This can occur when:\n- The file extension is not one of `.png`, `.jpg`, `.jpeg`, `.gif`, or `.webp`\n- The file exceeds the maximum file size of 20 MB\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Survey not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"$ref":"#/components/responses/ServerError"}}}}},"components":{"schemas":{"CoverImageUploadResponse":{"type":"object","properties":{"Status":{"type":"string"},"Body":{"description":"The full survey detail with the updated cover image URL — same structure as the Get a Survey response.\n","$ref":"#/components/schemas/Survey"}}},"Survey":{"allOf":[{"$ref":"#/components/schemas/SurveySummary"},{"type":"object","properties":{"Questions":{"type":"array","items":{"$ref":"#/components/schemas/Question"}}}}]},"SurveySummary":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"StartDate":{"type":"string","format":"date-time"},"EndDate":{"type":["string","null"],"format":"date-time"},"Status":{"type":"string","enum":["Active","Upcoming","Expired"],"description":"Automatically calculated from the date range. Active = no restrictions or currently within range; Upcoming = start date in the future; Expired = end date in the past.\n"},"CoverImageUrl":{"type":"string"},"QuestionsCount":{"type":"integer"},"ResponsesCount":{"type":"integer"},"CreatedDate":{"type":"string","format":"date-time"},"UpdatedDate":{"type":"string","format":"date-time"}}},"Question":{"type":"object","properties":{"Id":{"type":"integer","format":"int64"},"Question":{"type":"string"},"CustomFieldId":{"type":"integer","format":"int64"},"ResponseRequired":{"type":"boolean"},"ResponseEditable":{"type":"boolean"},"Rank":{"type":"integer"},"CustomField":{"$ref":"#/components/schemas/CustomField"}}},"CustomField":{"type":"object","description":"A custom field that defines the data collection type for a survey question.\n","properties":{"Id":{"type":"integer","format":"int64"},"Name":{"type":"string"},"Description":{"type":"string"},"DisplayType":{"type":"string","description":"The display type.","enum":["Paragraph","Multi-select","Dropdown list","Single-select","Date picker","Number","File"]},"Enumerations":{"type":"array","items":{"$ref":"#/components/schemas/Enumeration"}}}},"Enumeration":{"type":"object","description":"An allowed value for a selection-based custom field.","properties":{"Id":{"type":"integer","format":"int64"},"Value":{"type":"string"}}},"ErrorResponse":{"type":"object","description":"Error envelope returned by custom field write operations.","properties":{"Status":{"type":"string"},"Message":{"type":"string","description":"Human-readable error description."}}}},"responses":{"ServerError":{"description":"Internal server error."}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://integrations.impact.com/brand-api-reference/reference/surveys-and-custom-fields/surveys.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.