Get Started
Usage API
More information

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

Description

Returns the list of all user field values using the entity type and entity ID specified in the request

Parameters
Name Description Type Example
entityType
sent in url
Type
Allowed values: contact,person,company,opportunity,case
string some text
entityid
sent in url
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

This method doesn't return any data.

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "entityId": 14523423,
      "label": "Birthdate",
      "fieldValue": "2021-07-30T16:00:26.4477480Z",
      "fieldType": 5,
      "position": 10,
      "mask": "",
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <entityId>14523423</entityId>
    <label>Birthdate</label>
    <fieldValue>2021-07-30T16:00:26.4477480Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>