Dropdown Options

Manage selectable values on dropdown-type questions within a form.

Endpoints

MethodEndpointDescription
GET/forms/v1/forms/{formId}/questions/{questionId}List options
POST/forms/v1/forms/{formId}/questions/{questionId}Add options
PUT/forms/v1/forms/{formId}/questions/{questionId}/options/{optionId}Update an option
DELETE/forms/v1/forms/{formId}/questions/{questionId}/options/{optionId}Delete an option

Authentication

OperationScope
GETforms.read
POST, PUTforms.write
DELETEforms.delete

GET — Query Parameters

ParameterTypeRequiredDefaultDescription
includeDeletedbooleanNofalseInclude soft-deleted options.
limitintegerNo10Max results. Range 1–500.
offsetintegerNo0Pagination offset.

POST — Add Options

Appends new values; does not replace existing options. Duplicate values in one request are rejected.

curl --request POST \
  --url 'https://api.connecteam.com/forms/v1/forms/123456789/questions/abc123' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"dropdownOptions": [{"value": "Option A"}, {"value": "Option B"}]}'

PUT — Update Option

Replaces the label of an existing option.

curl --request PUT \
  --url 'https://api.connecteam.com/forms/v1/forms/123456789/questions/abc123/options/opt456' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"value": "Updated label"}'

Error Codes

HTTP StatusDescription
400Empty or duplicate option value.
401Missing or invalid authentication.
403Insufficient scope or form permission.
404Form, question, or option not found.
422Question is not a dropdown type.

Get dropdown options API Reference