Get a custom field

Returns the full definition of a single custom field, looked up by its API name. The shape always matches detail=true from GET /custom-fields.

Request

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

Path parameters

Name	Type	Required	Description
enterpriseId	string	yes	The enterprise (workspace) ID.
apiName	string	yes	API name of the field (e.g. contact_source, deal_size). Case-sensitive.

Example request

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

Responses

200 OK

{
  "type": "DROPDOWN",
  "apiName": "contact_source",
  "label": "Contact Source",
  "description": "How the lead was sourced",
  "isVisible": true,
  "isLeadid": false,
  "options": [
    { "id": "opt_1", "label": "Website" },
    { "id": "opt_2", "label": "Referral" },
    { "id": "opt_3", "label": "Cold Call" }
  ],
  "category": "Lead Details"
}

The object is returned unwrapped, and is identical to one entry from GET /custom-fields?detail=true — see that page for the full key list and the type-specific extras. It carries no internal id and no lockAfterCreate.

401 Unauthorized

See the universal 401 in the overview.

404 Not Found

{
  "error": {
    "code": "FIELD_NOT_FOUND",
    "message": "Could not find custom field with apiName contact_source"
  }
}

Notes

• Find the API name in Settings → Lead Fields → click the field → Properties → API name, or by listing all fields via GET /custom-fields.
• API names are case-sensitive — contact_source and Contact_Source are different lookups.
• category is the category's human-readable label, and is present only when the workspace has field categories enabled — otherwise the key is absent, not empty. A field with no category, or one pointing at a deleted category, reports Others. See Field categories.