Surveys

The ID of the survey definition to retrieve.

The ID of the survey definition.

The survey title.

The survey description. Defaults to an empty string.

The SurveyType enum value: 0 Individual, 1 Startup.

The ID of the community the survey belongs to.

The ID of the survey form whose questions this survey uses.

The current iteration of the survey, computed from startDate, iterationDuration and the current date. It is always 1 or greater — non-recurrent surveys and surveys with an iterationDuration of 0 report 1.

The length of one iteration in days, derived from iterationType: 7 Weekly, 30 Monthly, 90 Quarterly, 180 Semestral, 365 Yearly, customIteration (or 30) for Custom, and 30 otherwise.

The SurveyIterationType enum value: 0 Weekly, 1 Monthly, 2 Quarterly, 3 Semestral, 4 Yearly, 5 Custom, 6 NonRecurrent.

Whether eligible answers convert into KPI values.

The survey start date-time (ISO 8601).

The IANA timezone code the start date was entered in. Defaults to an empty string.

The survey end date-time (ISO 8601). null on definitions created before an end date was mandatory.

The IANA timezone code the end date was entered in. Defaults to an empty string.

The IANA timezone code the schedule runs in.

The circle IDs allowed to see the survey. Every ID the survey was created or updated with is stored as a community-circle ID — including project-circle IDs resolved on the create path — so they all appear here.

The community-user tag names the survey targets.

The IDs of the methodologies the survey targets. Methodologies are surfaced as Programs in the product.

The project tag names the survey targets.

The deadline of the current iteration (ISO 8601), computed from startDate, iterationType and iterationDuration. For non-recurrent surveys it is the endDate.

The users granted read access to this survey's responses. Described under surveyResponseViewers array items below.

Whether the surveyResponseViewers grant is active. While it is false the listed viewers get no access.

true when the authenticated user reaches this survey solely through the response-viewer grant — that is, they are not an admin of the survey's community.

The ID of the user granted read access to this survey's responses.

The viewer's name record. On this endpoint it is always populated; it is null on endpoints that return the viewer rows without the user record. Described under surveyResponseViewers[].user object below.

The ID of the viewer. Matches the enclosing userId.

The viewer's first name.

The viewer's last name.

The request is missing valid authentication.

The survey exists but you are not allowed to read it.

No survey definition with that ID exists. A missing survey surfaces as a 500 rather than a 404.

The ID of the community to list surveys for. Required.

The page size (number of definitions to return). Optional; defaults to 10.

The number of definitions to skip. Optional; defaults to 0.

Optional filter on the survey's lifecycle status. Described under statusFilters object below.

Optional filter on the survey's current iteration index. Described under iterationFilters object below.

The DynamicFilterType enum value: 0 IsAnyOf (keep matches), 1 IsNoneOf (exclude matches).

The SurveyStatus values to match: 0 Draft (the start date is in the future), 1 Active (started and not yet ended), 2 Expired (the end date has passed). The whole filter is ignored when this is null or empty, and values outside that range match nothing.

The DynamicFilterType enum value: 0 IsAnyOf, 1 IsNoneOf.

The iteration indexes to match. A survey's current index is the whole number of iterationDuration days elapsed since its startDate; surveys with an iterationDuration of 0 match the value 1. The whole filter is ignored when this is null or empty.

The total number of survey definitions matching the filters, ignoring paging. For a caller who is only a response viewer in the community this is instead the number of definitions in the returned page.

The page of survey definitions. Described under list array items below.

The ID of the survey definition. Use it with the get-a-survey-definition endpoint above for the full shape.

The survey title.

The survey start date-time (ISO 8601).

The survey end date-time (ISO 8601). null when the definition has no end date.

The current iteration of the survey. Always 1 or greater.

The request is missing valid authentication.

You are neither an admin of the given community nor a response viewer in it.

The ID of the community to file the survey under. Required.

The survey title.

A description of the survey.

The SurveyType enum value. Required.

The ID of the form whose questions this survey uses. Required. It also decides which community you must administer to make this call.

The SurveyIterationType enum value. Required.

Whether responses convert into KPI values. Required.

The survey start date-time (ISO 8601). Required.

The IANA timezone code for the schedule.

The survey end date-time (ISO 8601). Required in practice — the request is rejected when it is missing or earlier than startDate.

Circle IDs allowed to see the survey. Both community-circle and project-circle IDs are accepted and are resolved against the form's community; every resolved ID is stored as a community-circle ID, so all of them are echoed back in the response's surveyPrivacyCircles.

Methodology (Program) IDs the survey targets. Required together with or instead of surveyProjectTags when surveyType is 1 (Startup).

The response deadline (ISO 8601). Accepted but inert — it is never stored, and the deadline you read back is always computed from startDate, iterationType and iterationDuration.

Community-user tag names. On an Individual survey these select the recipients.

Project tag names. On a Startup survey these select the recipient projects.

The iteration length in days, used only when iterationType is 5 (Custom). Send null for every other iteration type — the value is ignored, and when iterationType is Custom a null falls back to 30 days.

The users to grant read access to this survey's responses. Only takes effect when allowAccessToResponses is true. Described under surveyResponseViewers array items below.

Whether the users listed in surveyResponseViewers may read this survey's responses. Defaults to false; while it is false the grant is inert.

The ID of a user to grant read access to this survey's responses. Duplicate userId values are collapsed, and sending null for the whole array is equivalent to sending an empty one.

Always null here. The viewer rows returned on the create path carry only userId.

Always false here. It is only computed on the get-by-id path.

The request body could not be parsed.

The request is missing valid authentication.

You are not an admin of the form's community.

The body failed validation — a missing endDate, an endDate earlier than startDate, or a Startup survey with neither surveyMethodologies nor surveyProjectTags.

The ID of the survey definition to update.

The ID of the community the survey belongs to. Required. It is both the permission scope for the call and the value written onto the survey.

The survey title.

A description of the survey.

The SurveyType enum value.

The ID of the form whose questions this survey uses.

The duration of an iteration, in days. Accepted but inert — the stored value is recomputed from iterationType and customIteration on every update.

Whether responses convert into KPI values.

The survey start date-time (ISO 8601).

Community-circle IDs allowed to see the survey. This is the full replacement set — the previous circles are deleted, and sending null or [] removes all of them. Unlike the create endpoint, every value here is stored as a community-circle ID; project circles are not resolved.

Methodology (Program) IDs the survey targets. Full replacement set; sending null or [] removes all of them.

The survey end date-time (ISO 8601).

Community-user tag names the survey targets. Full replacement set — tags not listed are dropped, new names are created, and sending null or [] removes all of them.

Project tag names the survey targets. Full replacement set; sending null or [] removes all of them.

The SurveyIterationType enum value.

The iteration length in days, used only when iterationType is 5 (Custom). Send null for every other iteration type — the value is ignored, and when iterationType is Custom a null falls back to 30 days.

The IANA timezone code for the schedule.

The full replacement set of response viewers. Viewers not present in the array are revoked; omitting the field or sending null revokes all of them. Described under surveyResponseViewers array items below.

Whether the users in surveyResponseViewers may read this survey's responses. It is written on every update, so omitting it sends false and switches the grant off.

The ID of a user granted read access to this survey's responses. Duplicate userId values are collapsed.

The request body could not be parsed.

The request is missing valid authentication.

You are not an admin of the community named in communityId.

No survey definition with that surveyId exists. A missing survey surfaces as a 500 rather than a 404.

The ID of the survey definition to delete.

The request is missing valid authentication.

You are not an admin of the survey's community.

No survey definition with that surveyId exists. A missing survey surfaces as a 500 rather than a 404.

The ID of the survey response to retrieve.

The ID of the survey response.

The ID of the user who authored the response.

The author's first and last name joined by a space.

The SurveyResponseStatus enum value: 0 Pending (draft), 1 Submitted.

The deadline of the iteration this response belongs to, as a date without a time (YYYY-MM-DD) — not a full date-time. null for surveys whose iterationType is 5 (Custom) or 6 (NonRecurrent), which have no per-iteration deadline.

The ID of the project the response was submitted on behalf of. null on Individual surveys and on any response with no project link.

The ID of the survey definition this response answers.

The title of the survey definition. An empty string when the definition could not be resolved.

The 1-based iteration this response belongs to.

The submitted answers. Described under answers array items below.

The name of the project in projectId. null when projectId is null.

The same value as iterationNumber, kept for backwards compatibility.

The tag names attached to this response.

Whether this response belongs to the survey's current iteration. Always true for a non-recurrent survey with an iterationDuration of 0.

The ID of the survey-form question this answer belongs to.

The answer value: free text, the selected option's text, a number, or the URL of a previously uploaded file.

The ID of the stored answer row.

The ID of the survey form the question belongs to. Matches the survey definition's formId.

The ID of the user who saved the answer.

When the answer was last saved (ISO 8601). null on answers stored without a timestamp.

The zero-based order of the selected option for choice questions. 0 for question types that carry no option.

The zero-based row order of the selected option for matrix and table questions. 0 for question types that carry no row.

The request is missing valid authentication.

The response exists but you are not allowed to read it.

No survey response with that ID exists. A missing response surfaces as a 500 rather than a 404.

The ID of the survey definition whose responses to list.

Optional filter on the response's submission date-time. Described under submissionDateFilters object below.

Optional filter on the response's tags. Described under tagFilters object below.

Optional filter on the response's status. Described under statusFilters object below.

Optional filter on the response's iteration number. Described under iterationFilters object below.

Optional filter on the response's community-project link. Described under projectFilters object below.

Optional filter on the response's author. Described under userFilters object below.

The page size. Optional; defaults to 10.

The number of responses to skip. Optional; defaults to 0.

Whether to embed each response's answers. Optional; defaults to false.

The DynamicFilterType enum value: 0 IsAnyOf, 1 IsNoneOf.

Submission date-times (ISO 8601) to match. The comparison is an exact equality test against each response's stored submission timestamp, not a range — a response matches only when its submission date-time is one of these values exactly. Under IsNoneOf the filter also keeps responses that were never submitted.

The DynamicFilterType enum value: 0 IsAnyOf, 1 IsNoneOf.

Tag names. A response matches when any of its tags is in the list.

The DynamicFilterType enum value: 0 IsAnyOf, 1 IsNoneOf.

The SurveyResponseStatus values to match: 0 Pending (draft), 1 Submitted. This is a different enum from the statusFilters on List survey definitions above, which uses SurveyStatus.

The DynamicFilterType enum value: 0 IsAnyOf, 1 IsNoneOf.

Iteration numbers to match, compared against each response's iterationNumber.

The DynamicFilterType enum value: 0 IsAnyOf, 1 IsNoneOf.

Community-project IDs, not project IDs. A response matches when its community-project link is in the list. Under IsNoneOf the filter additionally drops every response with no project link.

The DynamicFilterType enum value: 0 IsAnyOf, 1 IsNoneOf.

User IDs to match against each response's userId.

The total number of responses matching the filters, ignoring paging.

The page of survey responses. Described under list array items below.

The filter facets computed from the responses on this page. Described under surveyResponseFilters object below.

The earliest submission date-time among the returned responses (ISO 8601). Falls back to the current time when none of them has been submitted.

The latest submission date-time among the returned responses (ISO 8601). Falls back to the current time when none of them has been submitted.

The distinct tag names present on the returned responses.

Reserved for the response-status facet. This endpoint never populates it, so it is always null. Treat the two SurveyResponseStatus values (0 Pending, 1 Submitted) as the fixed, known set instead of reading them from here.

The distinct iteration numbers present on the returned responses.

The projects present on the returned responses. Described under surveyResponseFilters.projectFilters array items below.

The authors of the returned responses. Described under surveyResponseFilters.userFilters array items below.

The ID of the project.

The project's name.

The ID of a user who authored at least one of the returned responses.

The user's first name.

The user's last name.

The request is missing valid authentication.

You are neither an admin of the survey's community nor a designated response viewer of it.

No survey definition with that ID exists. A missing survey surfaces as a 500 rather than a 404.

The ID of the survey being answered. Required.

The SurveyResponseStatus enum value (0 Pending/Draft, 1 Submitted). Required.

The community-project link the response is submitted on behalf of. Optional, and the preferred way to attach a response to a startup.

The project the response is on behalf of (for Startup surveys). Optional. This is a fallback for clients that know the project but not the community-project link: it is resolved against the survey's own community, and communityProjectId takes precedence when both are sent.

Tag names to attach to the response. This endpoint does not persist them — use the bulk retag endpoint below to set a response's tags.

The answers being submitted. The field must be present, even if the array is empty. Described under answers array items below.

The ID of the survey-form question being answered. Required.

The answer value: free text, the selected option's text, a number, or the URL of a previously uploaded file.

The zero-based order of the selected option, for choice questions. Send 0 for question types that carry no option — 0 is the no-op value, not "omit the field".

The zero-based row order of the selected option, for matrix and table questions. Send 0 for question types that carry no row.

The ID of the newly created survey response. Returned with 201 Created; the body is a bare integer, not an object.

The request body could not be parsed.

The request is missing valid authentication.

You are not allowed to submit a response to this survey.

No survey with the given surveyId exists, or a response for this iteration already exists.

The ID of the survey response to update.

The SurveyResponseStatus enum value. Required.

The community-project link the response is submitted on behalf of. Always send the response's current value — the field is written straight through, so omitting it clears the link.

The project the response is on behalf of. Ignored on this endpoint; only the create endpoint resolves it into a community-project link.

Tag names to attach to the response. This endpoint does not persist them — use the bulk retag endpoint below to replace a response's tags.

The full replacement set of answers — every previously stored answer of this response is deleted and re-created from the payload, so answers omitted here are lost. The field must be present. Each item has the same shape as the answers array items of Create a survey response above.

The request body could not be parsed.

The request is missing valid authentication.

You are not allowed to update this response, or it has already been submitted.

No survey response with that surveyResponseId exists. A missing response surfaces as a 500 rather than a 404.

The ID of the survey response to retag. Required — an omitted value binds to 0 and matches no response.

The complete replacement set of tag names for that response. Every existing tag on the response is deleted and re-created from this list, so passing [] removes every tag from it.

The request is missing valid authentication.

You are not a community admin of the survey that owns the first item's response.

The first item's surveyResponseId does not exist.

The ID of the survey definition.

The earliest submission date-time across this survey's submitted responses (ISO 8601).

The latest submission date-time across this survey's submitted responses (ISO 8601).

The distinct tag names applied to at least one of this survey's responses.

Reserved for the response-status facet. This endpoint never populates it, so it is always null. Treat the two SurveyResponseStatus values (0 Pending/Draft, 1 Submitted) as the fixed, known set instead of reading them from here.

The distinct survey iteration numbers that have at least one response. Each matches the iterationNumber on a survey response.

The distinct projects that submitted a response. Empty for Individual surveys, which have no project link. Described under projectFilters array items below.

The distinct users that submitted a response. Described under userFilters array items below.

The ID of the project — the underlying project, not the community-project link.

The project name.

The ID of the responding user.

The user's first name.

The user's last name.

The request is missing valid authentication.

You are neither an admin of the survey's community nor a designated response viewer of it.

No survey definition with that ID exists, or the survey has no submitted responses yet.

The ID of the survey whose responses to export.

The survey iteration this response belongs to.

The project's name.

The name of the methodology (Program) that links the project to this survey. Empty when the project is not in one of the survey's methodologies.

The project's tags, comma-joined. Empty when the project has none.

The full name of the user who submitted the response.

The respondent's e-mail address.

The survey's SurveyIterationType rendered as its name — Weekly, Monthly, Quarterly, Semestral, Yearly, Custom or NonRecurrent — not the integer used in the JSON endpoints.

The submission timestamp. Empty for responses that were never submitted.

The survey iteration this response belongs to.

The full name of the user who submitted the response.

The respondent's e-mail address.

The name of the respondent's community circle. Empty when they are in none.

The respondent's community-user tags, comma-joined. Empty when they have none.

The survey's SurveyIterationType rendered as its name.

The submission timestamp. Empty for responses that were never submitted.

Every stored answer row, ||-joined.

The country name resolved from the stored option order.

The selected option labels, ||-joined.

The numeric option order as text.

The platform base URL concatenated with the stored path, giving an absolute file URL.

The raw answer with HTML tags stripped,   replaced by a space and _ replaced by -.

The request is missing valid authentication.

You are neither an admin of the survey's community nor a designated response viewer of it.

No survey with that surveyId exists. A missing survey surfaces as a 500 rather than a 404.

The ID of the community whose survey forms to list. Required. A missing or invalid value binds to 0 and yields an empty list.

The number of survey forms returned.

The survey forms belonging to the community. Described under list array items below.

The question-and-answer filter facets. This endpoint never populates it, so it is always null. When another endpoint populates it, each element is { "question": string, "answers": [string] }.

The ID of the survey form.

The form title.

The form description. HTML allowed.

The ID of the community that owns the form.

The FormType enum value. Survey forms always return 0 (Undefined).

When the form was created (ISO 8601). null for forms created before this field was tracked.

When the form was last saved (ISO 8601). null if it has never been updated since creation.

The ID of the user who created the form. 0 when no creator was recorded.

The form's questions. Described under list[].questions array items below.

The form's sections, sorted by order. Empty when the form has no sections. Described under list[].sections array items below.

Whether the form is shown on the community landing page.

Whether this is the community's default project form. Always false for survey forms.

How many survey definitions reference this form. Present on this endpoint only.

The ID of the section.

The section heading. A blank title is rejected on save, so this is always populated.

The section's description. null when not set.

The zero-based position of the section within the form. Sections are returned sorted by this value.

The ID of the question.

The question's internal title, used as a fallback label when question is null.

Help text shown under the question. HTML allowed. null when never set, "" when cleared.

The question text shown to respondents. null when the form only defines a title.

The zero-based position of the question within the form.

Whether an answer is required.

Whether the respondent can change the answer after submitting.

The FormQuestionAnswerType enum value — see the mapping in the Survey Forms preamble above.

Computed and read-only: true when answerType is negative, meaning the question maps onto a project field rather than a stored answer. Always false on survey forms.

Whether more than one option may be selected.

Reference links attached to the question. Described under list[].questions[].questionLinks array items below.

The selectable options, sorted by questionOptionOrder (alphabetically by label for answerType 11 Country). Described under list[].questions[].questionOptions array items below.

Whether answers to this question can be used as a filter facet. null when the flag was never set.

The PrivacyLevel enum value controlling who can see the answers.

The community-circle IDs allowed to see the answers when privacyLevel is 4 (Custom). Always [] on this endpoint — see the note above.

The FormQuestionConditionalLogicType enum value: 0 no conditions, 1 show when any condition matches, 2 show when all conditions match.

The conditions that make this question appear. Empty when conditionalLogicType is 0. Described under list[].questions[].formQuestionConditionalLogicList array items below.

Whether the question was copied from an application form. Always false on survey forms.

Computed and read-only: true when weightedAverage has a value. Always false on survey forms.

The question's weight, used only by evaluation forms. Always null on survey forms.

Whether answers to this question are converted into KPI values.

The PrivacyLevel required to change the answer. Always 0 (Undefined) on survey forms.

The FormQuestionType enum value. Always 0 on survey forms.

Whether the answer is surfaced on the project profile. Always false on survey forms.

Whether a length limit applies to the answer.

The FormQuestionLimitType enum value: 1 characters, 2 words. null when hasLimit is false.

The maximum number of characters or words. null when hasLimit is false.

The default community project-form question this one mirrors. Always null on survey forms.

The ID of the section this question belongs to, or null when the question is not in a section.

A reference URL attached to the question. This is the element's only member — the link's own ID is not exposed.

The ID of the option.

The option label shown to respondents.

The zero-based position of the option. Answers reference this order, not the option ID.

The ID of the condition row.

The ID of the question whose answer is tested. It is always another question on the same form.

The ID of the option the answer is compared against, for choice questions. null when customValue is used instead.

The literal value the answer is compared against, for free-text questions. null or "" when formQuestionOptionId is used instead. The two are mutually exclusive.

The FormQuestionConditionLogic comparison — see the mapping in the Survey Forms preamble above.

The request is missing valid authentication.

The ID of the survey form to retrieve.

The request is missing valid authentication.

No survey form with that ID exists.

The form title.

A description of the form. HTML allowed.

The owning community ID. Required, and it must be an existing community.

The FormType enum value. Required by the schema, but not round-tripped — survey forms always return 0 (Undefined).

The full set of questions. Described under questions array items below.

The form sections. Described under sections array items below. Omitting the key entirely leaves existing sections untouched.

Whether to show this form on the community landing page.

Whether this is the default community project form.

The ID of the question. Use 0 for a new question.

The question's internal title, used as the label when question is omitted.

Help text shown under the question. HTML allowed.

The question text shown to respondents.

The zero-based position of the question within the form.

Whether an answer is required.

Whether the respondent can change the answer after submitting.

The FormQuestionAnswerType enum value — see the mapping in the Survey Forms preamble above.

Whether more than one option may be selected.

Reference links to attach to the question. Omit or send [] for none. Described under questions[].questionLinks array items below.

The selectable options. Ignored for answerType 11 (Country), whose options are managed by the platform. Described under questions[].questionOptions array items below.

Whether answers to this question can be used as a filter facet.

The PrivacyLevel enum value controlling who can see the answers.

Community-circle IDs allowed to see the answers when privacyLevel is 4 (Custom). Send [] for none. On a question being created, every ID must resolve to an existing community circle — a request that mixes valid and unknown IDs fails with a 500. When none of the IDs resolves, the list is silently ignored.

The FormQuestionConditionalLogicType enum value. For a question that already exists on the form, conditions are only persisted when its conditionalLogicType is 1 or 2. For a question created in the same call the conditions are mapped regardless of conditionalLogicType — but conditionLogic is not carried through and every conditionFormQuestionId must already exist on the form, so create the questions first and add their conditional logic in a follow-up PUT.

The conditions that make this question appear. Described under questions[].formQuestionConditionalLogicList array items below.

Whether the question carries an evaluation weight. Ignored on survey forms.

The question's weight. Ignored on survey forms.

Whether answers to this question are converted into KPI values.

The PrivacyLevel required to change the answer. Ignored on survey forms.

The FormQuestionType enum value. Ignored on survey forms.

Whether the answer is surfaced on the project profile. Ignored on survey forms.

Whether a length limit applies to the answer. Set hasLimit, limitType and limitValue consistently — an inconsistent combination is stored as sent.

The FormQuestionLimitType enum value: 1 characters, 2 words. Send null when hasLimit is false.

The maximum number of characters or words allowed. Send null when hasLimit is false.

Links the question to a default community project-form question. Ignored on survey forms.

Places the question in a section. For a section that already exists, send its id. For a section being created in the same request (sections[].id of 0), send that section's order instead — the server resolves it once the section has been created. A value matching neither is cleared to null.

A reference URL to show alongside the question. This is the element's only member; links are replaced wholesale on every save.

Use 0 to create a new option. On update, reusing an existing option's ID keeps its stored answers attached.

The option label shown to respondents.

The zero-based position of the option. Existing answers are re-pointed when this order changes.

Ignored on write — conditions are always re-created. Send 0.

The ID of the question whose answer is tested. It must already exist on this form, otherwise the request is rejected.

The option ID the answer is compared against. Mutually exclusive with customValue.

The literal value the answer is compared against. Mutually exclusive with formQuestionOptionId.

The FormQuestionConditionLogic comparison (1–8). Values outside that range are rejected. Not carried through on the create path — see the note above.

Use 0 to create a new section. On update, an id greater than 0 must belong to this form.

The section heading. Required — a blank or whitespace title is rejected.

The section description. Optional.

The zero-based position of the section. Must be unique within the form. It doubles as the handle a new question uses in sectionId before the section has an ID.

The request body could not be parsed.

The request is missing valid authentication.

An unknown or zero communityId, invalid conditional-logic data, a blank section title, a duplicate section order, or an unknown section ID.