Get all forms | PlannrCRM API documentation

Get all forms Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

GET /api/v1/form

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[live] boolean

Get forms that have or have not been published.
filter[visibility] string

Get forms of this visibility value, Available types are 'hidden', 'public', 'private', and 'internal'.
filter[title] string

Get forms with a title that match this filter.
filter[created_after] string

Date to filter when the record was created after.
filter[created_before] string

Date to filter when the record was created before.
sort string

Field to sort by. Valid fields are [created_at, updated_at, title]. Negative sign to denote DESC. Defaults to '-created_at'.
per_page integer

Number of results to return with pagination (Default 15. Max 500).

Responses

200 application/json
Hide response attribute Show response attribute object
- data array[object]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  title string
  
  description string
  
  live boolean
  
  visibility string
  
  sections object
  
  Hide sections attributes Show sections attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  section object
  
  Hide section attributes Show section attributes object
  
  uuid
  
  The UUID of the resource.
  
  created_at
  
  The timestamp of when the resource was created.
  
  updated_at
  
  The timestamp of when the resource was updated.
  
  title
  
  The title of the section
  
  position
  
  The position of the section
  
  title string
  
  help_text string
  
  caption string
  
  type string
  
  required boolean
  
  position integer
  
  selection_options array[string]
  
  target_field string
  
  key string
  
  linked_question object
  
  Hide linked_question attributes Show linked_question attributes object
  
  type
  
  Type of question
  
  field
  
  The field this question is linked to
  
  label
  
  The label this question is linked to
  
  formatted_field
  
  The field formatted in title case
  
  selection_options
  
  The selection options for selection type questions
  
  is_custom_field
  
  Denotes if this is linked to a custom field
  
  forced_required
  
  Denotes if this is question must be required
  
  caption
  
  Placeholder caption for this question
  
  linked_primary boolean
  
  allowed_hosts array[string]
  
  draft_submissions_count integer
  
  submitted_submissions_count integer
  
  create_client boolean
  
  client_type string

GET /api/v1/form

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/form' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "uuid": "d4fa4c18-3caf-4313-916b-d26c4bc8d07d",
      "created_at": "2026-08-07T15:29:25+01:00",
      "updated_at": "2026-08-07T15:29:25+01:00",
      "title": "Annual Catchup 2022",
      "description": "This is the annual catchup form for 2022",
      "live": true,
      "visibility": "public",
      "sections": {
        "uuid": "e5b6362a-e559-4efb-bee2-fed4c4c474d3",
        "created_at": "2026-08-07T15:29:25+01:00",
        "updated_at": "2026-08-07T15:29:25+01:00",
        "section": {
          "uuid": "7f1a0831-c30a-4bc3-859a-47958d4f4280",
          "created_at": "2026-08-07T15:29:32+01:00",
          "updated_at": "2026-08-07T15:29:32+01:00",
          "title": "Personal Details",
          "position": 1
        },
        "title": "What is your name?",
        "help_text": "Gareth",
        "caption": "Your full legal name",
        "type": "string",
        "required": true,
        "position": 1,
        "selection_options": [
          "option 1",
          "option 2"
        ],
        "target_field": "name",
        "key": "what_is_your_name",
        "linked_question": {
          "type": "selection",
          "field": "gender",
          "label": "Gender",
          "formatted_field": "Gender",
          "selection_options": [
            "male",
            "female",
            "non-binary",
            "transgender",
            "intersex",
            "other",
            "unknown"
          ],
          "is_custom_field": false,
          "forced_required": false,
          "caption": "Your drink preference"
        },
        "linked_primary": true
      },
      "allowed_hosts": [
        "domain.com",
        "subdomain.domain.com"
      ],
      "draft_submissions_count": 5,
      "submitted_submissions_count": 5,
      "create_client": true,
      "client_type": "client"
    }
  ]
}