Get a form

GET /api/v1/form/{uuid}

Path parameters

Responses

  • 201 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.

    • title string

      The title of the form

    • description string

      The description of the form

    • live boolean

      Whether the form is live

    • visibility string

      The visibility of the form

    • sections object

      The sections of the form. They include the forms questions in a array

    • allowed_hosts array[string]

      Array of allowed domains that this form can be accessed from using different origins

    • draft_submissions_count integer

      Count of draft submissions against this form

    • submitted_submissions_count integer

      Count of submitted submissions against this form

    • create_client boolean

      Denotes if this form creates a new client when it is submitted from a public embed

    • client_type string

      If create_client is true, then the client_type is the type of client that will be created, possible values are client and prospect
GET /api/v1/form/{uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/form/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 (201) 
{
  "live": true,
  "uuid": "cf4374eb-da20-4ead-b713-99a362023bfa",
  "title": "Annual Catchup 2022",
  "sections": {
    "key": "what_is_your_name",
    "type": "string",
    "uuid": "d904d397-6d8a-460d-b39b-5f729fb559e9",
    "title": "What is your name?",
    "caption": "Your full legal name",
    "section": "App\\Http\\Resources\\FormSectionResource",
    "position": 1,
    "required": true,
    "help_text": "Gareth",
    "created_at": "2024-10-16T11:10:14+01:00",
    "updated_at": "2024-10-16T11:10:14+01:00",
    "target_field": "name",
    "linked_primary": true,
    "linked_question": "App\\Http\\Resources\\FormBuilder\\LinkedFormQuestionResource",
    "selection_options": [
      "option 1",
      "option 2"
    ]
  },
  "created_at": "2024-10-16T11:10:14+01:00",
  "updated_at": "2024-10-16T11:10:14+01: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
}