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. Each field's resolved <code>tags</code> (separate namespace from Prospect Tags) is included in the response.

get/v1/fields

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/fields/get.ts
A function with typed inputs. Its response is checked against the schema.

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

unknown required

Example response

{
  "message": "Successfully fetched fields of the user",
  "payload": [
    {
      "id": "0VOLRwYe82",
      "label": "First Name",
      "fieldType": "text",
      "tags": []
    },
    {
      "id": "pRjY60lBPa",
      "label": "Last Name",
      "fieldType": "text",
      "tags": []
    },
    {
      "id": "KNz9Zgl7R3",
      "label": "Deal Stage",
      "fieldType": "dropdown",
      "tags": [
        {
          "id": "aB3xQ12z",
          "name": "CRM"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.