Skip to main content
GET
/
custom-fields
curl -H "X-API-KEY: your_api_key" "https://www.gomry.com/api/v1/custom-fields"

{
  "data": [
    {
      "id": "<string>",
      "name": {},
      "description": {},
      "type": {},
      "record_type": {},
      "required": true,
      "options": [
        {
          "id": "<string>",
          "label": "<string>",
          "synonyms": [
            "<string>"
          ]
        }
      ],
      "status": {},
      "created_at": {},
      "updated_at": {}
    }
  ]
}

​
List Custom Fields

Returns the custom field definitions used to interpret the custom_fields map on contact responses. Required scope: custom_fields:read

​
Query Parameters

​
page
integer
default:"1"
​
page_size
integer
default:"50"
Maximum: 200.
​
record_type
string
Filter by record type. Currently only contact.

​
Response

​
data
array
curl -H "X-API-KEY: your_api_key" "https://www.gomry.com/api/v1/custom-fields"