Retrieve a form using its ID.

Retrieve detailed information about a specific form, including its label, type, and possible refvalues.

A form represents a field or a question that can be associated with a contact. It contains:

• Label: The name or description of the form (e.g., “What is your preferred contact method?”).
• Type: The format of the form, such as radio, text, checkbox, numeric, date, range, signature or photos
• Refvalues: A list of possible answers or predefined values associated with the form. These can be simple options (e.g., “Yes” or “No”) or a range of values, depending on the form type.

Here’s an example of a form with a range type, where the refvalue specifies a minimum, maximum, and step for the range of answers:

{
  "id": 12515,
  "type": "range",
  "section": "My city and me",
  "order": 1,
  "label": "On a scale of 1 to 10, how would you rate your satisfaction with the council?",
  "refvalues": [
    {
      "id": 19477,
      "form_id": 12515,
      "min": 0,
      "max": 10,
      "step": 1
    }
  ]
}

This allows the form to represent a sliding scale, and the response can specify any value within this range.

Link with contacts: formdatas & custom_fields

When retrieving or working with contacts, the formdatas field links forms and refvalues to a contact. Custom fields have a dedicated structure in the contact object.

Each entry in formdatas and custom_fields contains:

• form_id: The ID of the form.
• form_ref_id: The ID of the refvalue selected for that form.
• data: The actual value or answer provided (e.g., “7” for a rating of 7 on the scale from 0 to 10).

Example of formdatas in a contact for the range form:

"formdatas": [
  {
    "form_id": 12515,
    "form_ref_id": 19477,
    "data": "7"
  }
],
"custom_fields": [
  {
    "form_id": 11391,
    "form_ref_id": 18151
    "data": "Architect",
  }
]

GET /forms/{formId}

Error

A valid request URL is required to generate request examples

200

{
  "status": "success",
  "data": {
    "form": {
      "id": 123,
      "CreatedAt": "<string>",
      "UpdatedAt": "<string>",
      "group_id": [
        123
      ],
      "section": "<string>",
      "activate": "<string>",
      "order": 123,
      "label": "<string>",
      "refvalues": [
        {
          "id": 123,
          "CreatedAt": "<string>",
          "UpdatedAt": "<string>",
          "form_id": 123,
          "label": "<string>",
          "value": "<string>",
          "min": 123,
          "max": 123,
          "step": 123,
          "type": "<string>",
          "followed": true,
          "color": "<string>"
        }
      ],
      "mandatory": true
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

formId · integer · required

ID of the form to return

Response

200 - application/json

Successful operation

status · string

Example:

"success"

data · object

Show child attributes