GET api/2.0/crm/{entityType}/customfield/definitions This function requires authentication

Description

Returns a list of descriptions for all the existing custom fields.

Parameters

Name	Description	Type	Example
entityType sent in url	Entity type Allowed values: contact, person, company, opportunity, case	string	some text

Example

GET api/2.0/crm/%22some+text%22/customfield/definitions
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

List of custom fields

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "RelativeItemsCount": 0,
      "id": 1234,
      "EntityId": 14523423,
      "Label": "Birthdate",
      "FieldValue": "2020-12-08T17:37:04.5916406Z",
      "FieldType": 5,
      "Position": 10,
      "Mask": ""
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <RelativeItemsCount>0</RelativeItemsCount>
    <id>1234</id>
    <EntityId>14523423</EntityId>
    <Label>Birthdate</Label>
    <FieldValue>2020-12-08T17:37:04.5916406Z</FieldValue>
    <FieldType>5</FieldType>
    <Position>10</Position>
    <Mask />
  </response>
</result>

GET api/2.0/crm/{entityType}/customfield/definitions This function requires authentication

Get information

Get help