List custom fields

Returns all custom field definitions in the workspace. Use this to discover the API names of fields before posting leads or actions.

Request

Field	Value
Method	GET
URL	https://next.telecrm.in/autoupdate/v2/enterprise/{enterpriseId}/custom-fields
Auth	Bearer token (Sync-typed). See Authentication.

Path parameters

Name	Type	Required	Description
enterpriseId	string	yes	The enterprise (workspace) ID.

Query parameters

Name	Type	Default	Description
detail	boolean	false	When true, returns full field definitions including IDs, descriptions, option metadata, and date formats. When false, returns a summary view with type, apiName, lockAfterCreate, isLeadid, and option/tag labels.

WARNING

The response shape differs between detail=true and detail=false. Clients that read both modes must branch on the customFields[] item shape — see Pitfalls.

Example request

curl "https://next.telecrm.in/autoupdate/v2/enterprise/{enterpriseId}/custom-fields?detail=true" \
  -H "Authorization: Bearer YOUR_SYNC_TOKEN"

Responses

200 OK (summary, detail=false)

{
  "customFields": [
    {
      "type": "DROPDOWN",
      "apiName": "contact_source",
      "lockAfterCreate": false,
      "isLeadid": false,
      "options": ["Website", "Referral", "Cold Call"]
    },
    {
      "type": "PHONE",
      "apiName": "phone",
      "lockAfterCreate": false,
      "isLeadid": true
    }
  ]
}

200 OK (detailed, detail=true)

{
  "customFields": [
    {
      "id": "5f8a1b2c3d4e5f6a7b8c9d0e",
      "type": "DROPDOWN",
      "apiName": "contact_source",
      "description": "How the lead was sourced",
      "lockAfterCreate": false,
      "isLeadid": false,
      "options": [
        { "id": "opt_1", "label": "Website" },
        { "id": "opt_2", "label": "Referral" }
      ]
    }
  ]
}

401 Unauthorized

See the universal 401 in the overview.

404 Not Found

{
  "error": {
    "code": "ENTERPRISE_NOT_FOUND",
    "message": "The enterprise with ID 62ab16e was not found."
  }
}

Notes

• Field type enum: TEXT, NUMBER, EMAIL, PHONE, DATE, DROPDOWN, TAGS, MONEY, WEBSITE, UNIQUE. See Field Types for input rules per type.
• The field with isLeadid: true is the workspace's lead identifier — its API name is the key every lead payload must include.
• dateFormat and timeFormat (returned in detailed mode) tell you the workspace's expected date input format for date fields.