Schemas

Get Field Schemas for an Entity

Changed on

Lists the filterable and sortable fields for entity, one of accounts, contacts, meetings, opportunities, sequences, or tasks.

Each entry carries the field's key, the allowed_operators it supports, and an updatable flag — updatable: false marks a read-only field (system-derived or create-only). Custom fields use custom_field_{uuid} keys and are always updatable, though AI auto-filled ones may later be overwritten by AI. An AI auto-filled custom field carries the question AI answers to fill it under custom_field_settings.question. Enum and select fields list their accepted values under enum_field_settings.allowed_values.

On date fields, allowed_values are semantic periods for the is and is_not operators, while equals, greater_than, and less_than take raw YYYY-MM-DD. datetime fields have no is operator — compare them against an ISO 8601 timestamp.

get/v1/schemas/{entity}

Request

  • Base URL
    https://api.monaco.com
  • URL
    https://api.monaco.com/v1/schemas/{entity}
  • Auth
    none declared

Path parameters

entitystring required

Response

Successful Response

Example response

{
  "data": [
    {
      "name": "Account Status",
      "key": "status",
      "type": "enum",
      "parent": "company",
      "filterable": true,
      "sortable": true,
      "updatable": true,
      "allowed_operators": [
        "is",
        "is_not",
        "is_empty",
        "is_not_empty"
      ],
      "custom_field_settings": {
        "id": "cf_abc123",
        "question": "Does this company publish a public pricing page? Answer true or false."
      },
      "enum_field_settings": {
        "allowed_values": [
          {
            "display_value": "Active",
            "key": "active"
          }
        ]
      }
    }
  ]
}

Changes

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property // to the response with the status