Get a question

GET /api/v1/form/{form_uuid}/question/{uuid}

Path parameters

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • section object

      The section this question belongs to

      Additional properties are allowed.

    • title string

      The title of the question

    • help_text string

      Input placeholder text

    • caption string

      Text to describe the input

    • type string

      The type of question

    • required boolean

      Whether the question is required

    • position integer

      The position of the question in the section

    • selection_options array[string]

      The options for selection questions

    • target_field string

      The field to update upon question completion

    • key string

      The key to use when updating the target field

    • linked_question object

      the linked form question

      Additional properties are allowed.

    • linked_primary boolean

      Will the this linked field become a primary Address/Phone Number/Email Address
GET /api/v1/form/{form_uuid}/question/{uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/form/form_uuid/question/uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "key": "what_is_your_name",
  "type": "string",
  "uuid": "0fb19d70-64a2-43c5-84f3-6e16f4f52004",
  "title": "What is your name?",
  "caption": "Your full legal name",
  "section": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "502c00ea-2dcb-4b09-b237-659801e2eead",
    "title": "Personal Details",
    "position": 1,
    "questions": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-01-17T11:18:30+00:00",
    "updated_at": "2025-01-17T11:18:30+00:00"
  },
  "position": 1,
  "required": true,
  "help_text": "Gareth",
  "created_at": "2025-01-17T11:18:30+00:00",
  "updated_at": "2025-01-17T11:18:30+00:00",
  "target_field": "name",
  "linked_primary": true,
  "linked_question": {
    "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"
    ]
  },
  "selection_options": [
    "option 1",
    "option 2"
  ]
}