Get Started
Usage API
More information

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

Description

Returns a list of all the custom fields for the entity type and ID specified in the request.

Parameters
Name Description Type Example
entityType
sent in url
Entity type
Allowed values: contact, person, company, opportunity, case
string some text
entityid
sent in url
Entity ID number 1234
Example
GET api/2.0/crm/some+text/1234/customfield
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of entity custom fields

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "entityId": 14523423,
      "label": "Birthdate",
      "fieldValue": "2021-10-19T03:55:36.5178484Z",
      "fieldType": 5,
      "position": 10,
      "mask": "",
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <entityId>14523423</entityId>
    <label>Birthdate</label>
    <fieldValue>2021-10-19T03:55:36.5178484Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>