Form Fields

List all Form Fields

Changed on

Filtering

This endpoint supports result filtering. For more information on how to filter this request, go here.

OAuth Scope

This endpoint requires the following OAuth scope read_forms.

get/formfield.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/formfield.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: read_forms

Response

An array of Form Fields

form_uuidstring uuid

The UUID of the form this field belongs to.

namestring

The name of the form field.

field_data_jsonstring

JSON configuration for this question, including type, mandatory, choices and conditions.

sort_orderinteger

The sort order of the form field.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

Example response

[
  {
    "form_uuid": "123e4567-196b-4438-afbf-23f94657b72b",
    "uuid": "123e4567-6ce7-4e37-bb4b-23f94df46b8b",
    "edit_date": "2026-03-01 12:00:00"
  }
]

Changes

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 1a0e16a1e017Revision changes
    • breaking

      the / response's property type changed from string to integer for status