Get a form's section

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

Headers

Path parameters

form_uuid integer Required
uuid string Required

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.
- form object
  
  The form this section belongs to
  
  Additional properties are allowed.
- title string
  
  The title of the section
- position integer
  
  The position of the section
- questions object
  
  The questions in the section
  
  Additional properties are allowed.

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

curl \
 -X GET https://api.plannrcrm.com/api/v1/form/form_uuid/section/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)

{
  "form": {
    "live": true,
    "uuid": "05980284-c813-4e5a-8cee-a1c7d1746aae",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-01-17T11:18:30+00:00",
    "updated_at": "2025-01-17T11:18:30+00:00",
    "visibility": "public",
    "client_type": "client",
    "description": "This is the annual catchup form for 2022",
    "allowed_hosts": [
      "domain.com",
      "subdomain.domain.com"
    ],
    "create_client": true,
    "draft_submissions_count": 5,
    "submitted_submissions_count": 5
  },
  "uuid": "3a51e41c-c5ff-4e8b-b567-4f8dfc939f42",
  "title": "Personal Details",
  "position": 1,
  "questions": {
    "key": "what_is_your_name",
    "type": "string",
    "uuid": "1f12ac21-2f0d-411b-872d-245c7a94fdb7",
    "title": "What is your name?",
    "caption": "Your full legal name",
    "section": "App\\Http\\Resources\\FormSectionResource",
    "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": "App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource",
    "selection_options": [
      "option 1",
      "option 2"
    ]
  },
  "created_at": "2025-01-17T11:18:30+00:00",
  "updated_at": "2025-01-17T11:18:30+00:00"
}