Get all Linked Questions

GET /api/v1/linked-form-questions

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[type] string

Get all questions of this form question type
filter[field] string

Get questions that match this field
sort string

Field to sort by. Valid fields are [type, field]. Negative sign to denote DESC. Defaults to 'field'.

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  type string
  
  field string
  
  label string
  
  formatted_field string
  
  selection_options array[string]
  
  is_custom_field boolean
  
  forced_required boolean
  
  caption string

GET /api/v1/linked-form-questions

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/linked-form-questions' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": [
    {
      "type": "selection",
      "field": "gender",
      "label": "Gender",
      "caption": "Your drink preference",
      "forced_required": false,
      "formatted_field": "Gender",
      "is_custom_field": false,
      "selection_options": [
        "male",
        "female",
        "non-binary",
        "transgender",
        "intersex",
        "other",
        "unknown"
      ]
    }
  ]
}