Sign in
fields

List all fields

Returns a list of fields defined in your account. Pass <code>systemFields=true</code> to include built-in system fields (such as First Name, Last Name, Email) along with your custom fields. Pass <code>systemFields=false</code> or omit the parameter to return only custom fields.

get/v1/fields

Query parameters

systemFields'true' | 'false' required

Pass <code>true</code> to include built-in system fields (such as First Name, Last Name, and Email) along with your custom fields. Pass <code>false</code> or omit this parameter to return only custom fields.

Response

Successfully fetched fields of the user

{"stackTrail":"paths:/v1/fields:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"message":"Successfully fetched fields of the user","payload":[{"id":"0VOLRwYe82","label":"First Name","fieldType":"text"},{"id":"pRjY60lBPa","label":"Last Name","fieldType":"text"},{"id":"KNz9Zgl7R3","label":"Email","fieldType":"text"}]}}

Example response

{
  "message": "Successfully fetched fields of the user",
  "payload": [
    {
      "id": "0VOLRwYe82",
      "label": "First Name",
      "fieldType": "text"
    },
    {
      "id": "pRjY60lBPa",
      "label": "Last Name",
      "fieldType": "text"
    },
    {
      "id": "KNz9Zgl7R3",
      "label": "Email",
      "fieldType": "text"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.