crm

List fields

List fields for a CRM object, including read-only calculation metadata.

get/crm/objects/{objectName}/fields

Request

  • Base URL
    https://www.dench.com/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

objectNamestring required

Response

Successful response

_idstring required
_creationTimenumber required
organizationIdstring required
objectIdstring required
namestring required
descriptionstring
type'text' | 'email' | 'phone' | 'url' | 'number' | 'boolean' | 'date' | 'richtext' | 'file' | 'user' | 'enum' | 'relation' | 'tags' | 'action' required

Field data type. relation needs relatedObjectName + relationshipType; enum uses enumValues/enumColors; user cells store one member userId or an array of member userIds; long prose belongs in the protected Notes richtext field.

requiredboolean required
defaultValuestring
relatedObjectIdstring
relationshipType'many_to_one' | 'many_to_many'

Relation cardinality for a relation field.

enumValuesstring[]
enumColorsstring[]
enumMultipleboolean
sortOrdernumber required
indexedboolean
createdAtnumber required
updatedAtnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.