Get Started
Portal api methods
Help

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

Description

Returns the list of descriptions for all existing user fields

Parameters
Name Description Type Example
entityType
sent in url
Type string some text
Example
GET api/2.0/crm/some+text/customfield/definitions
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

User field list

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "relativeItemsCount": 0,
      "entityId": 14523423,
      "label": "Birthdate",
      "fieldValue": "2019-08-24T10:53:56.0466440Z",
      "fieldType": 5,
      "position": 10,
      "mask": "",
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <relativeItemsCount>0</relativeItemsCount>
    <entityId>14523423</entityId>
    <label>Birthdate</label>
    <fieldValue>2019-08-24T10:53:56.0466440Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>