Get all forms

GET /api/v1/form

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' and 'private' ,Example 'hidden'

  • filter[title] string

    Get forms with a title that match this filter. Example 'Annual review'

  • filter[created_after] string

    Date to filter when the record was created after. Example 2022-04-05

  • filter[created_before] string

    Date to filter when the record was created before. Example 2022-05-31

  • 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
GET /api/v1/form 
curl \
 -X GET https://api.plannrcrm.com/api/v1/form \
 -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) 
{
  "data": [
    {
      "live": true,
      "uuid": "290f920d-51e7-4dbc-ad5a-09712109bb57",
      "title": "Annual Catchup 2022",
      "sections": {
        "key": "what_is_your_name",
        "type": "string",
        "uuid": "b69ddaa9-f9fd-423e-b1f9-08b119fe137c",
        "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
    }
  ]
}