# Field definitions

The /api/fields/ endpoint enables you to retrieve information about the fields defined in Iteras.

# Parameters

The endpoint uses GET and currently supports the following parameter:

• "id" - (optional) field ids, e.g. ?id=birthday&id=:Cancellation reason. The id is either the field name with a colon prepended or if defined the external identifier of the field. Remember to URL encode the ids.

# Return value

The data returned is an object with an array of field definitions (possibly empty array).

{
  "fields": [
    {
      "name": "Title",
      "id": ":Title",
      "type": "text"
    },
    {
      "name": "Subscription type",
      "id": "subscription_type",
      "type": "choice",
      "choices": [
        {
          "name": "Professionel",
          "identifier": "pro"
        },
        {
          "name": "Personal",
          "identifier": "personal"
        },
        {
          "name": "Business",
          "identifier": "business"
        }
      ]
    }
  ]
}