Skip to main content

​
List custom field definitions

​
page
integer
default:"1"
Page number
​
per_page
integer
default:"25"
Items per page (max 250)
​
sort
string
Sort field
​
order
string
default:"desc"
Sort order: asc or desc
​
entity_type
string
Filter by entity type: contacts, companies, or deals
GET /api/v1/custom-fields

​
Get a custom field definition

GET /api/v1/custom-fields/:id

​
Create a custom field definition

POST /api/v1/custom-fields
​
entity_type
string
required
Entity type: contacts, companies, or deals
​
field_name
string
required
Field name in snake_case (lowercase letters, numbers, underscores)
​
field_label
string
required
Human-readable display label
​
field_type
string
required
Field type: text, number, select, multiselect, date, or checkbox
​
field_options
string[]
Options for select and multiselect types
​
required
boolean
default:"false"
Whether the field is required
​
display_order
integer
default:"0"
Display order (lower numbers appear first)
Example
curl -X POST https://api.mosscrm.com/api/v1/custom-fields \
  -H "X-API-Key: moss_k_..." \
  -H "Content-Type: application/json" \
  -d '{
    "entity_type": "contacts",
    "field_name": "contract_tier",
    "field_label": "Contract Tier",
    "field_type": "select",
    "field_options": ["starter", "pro", "enterprise"],
    "required": true
  }'

​
Update a custom field definition

Field name and type cannot be changed after creation. 
PATCH /api/v1/custom-fields/:id
​
field_label
string
Display label
​
field_options
string[]
Options (for select/multiselect types)
​
required
boolean
Whether the field is required
​
display_order
integer
Display order

​
Delete a custom field definition

Deletes the definition and all values across all entities. 
DELETE /api/v1/custom-fields/:id