Query Data

POST {{host}}/api/rest/v4/data/entrydata/rows/query/{{entryTypeId}}
Authorization: Bearer {{token}}
Content-Type: application/json

The key differences between this endpoint and the GET endpoint are:

With this POST endpoint, parameters are sent in the request body.
With the GET endpoint, parameters are included in the URL path and sent using the GET method.

Tip: The endpoint uses the HTTP POST method.

Params

Name	Parameter Type	Data Type	Values	Description
entryTypeId	Path	string/int	`company` or `2011`	Unique identifier of the object or its name
query	Body	string	FilterOperations	Filter query syntax
fields	Body	array	`["firstName", "lastName"]`	Specify a subset of fields to return
limit	Body	int	`1000`	See Pagination for details
skip	Body	int	`0`	See Pagination for details
resolveReferenceUrls	Body	boolean	`false`	If true, returns URL of entry for reference fields
wrapIntoArrays	Body	boolean	`true`	Improves consistency for multi-value fields
dateTimeBehavior	Body	int	`0` or `1`	Default setting of 0 returns date-time in UTC. 1 returns date-time values localized to user/client's time-zone settings

Note: When skip and limit are not included as parameters, default values of 0 and 1000 are applied respectively.

Samples

Sample Requests

Using proper pagination, returns all fields for a given entry type.

Body

{
  "limit": 1000,
  "skip": 0,
  "wrapIntoArrays": true
}

Response

{
  "totalRecords": 1,
  "rows": [
    {
      "EntryId": 2772624,
      "Subject": {
        "type": 0,
        "id": 2772624,
        "name": "Test Interactions",
        "entryListId": 2013
      },
      "Attachments": {
        "type": 0,
        "id": 3043023,
        "name": "REST API Guide_20201009.docx",
        "entryListId": 2010
      },
      "Date": "2020-12-30T05:00:00Z",
      "EnteredBy": {
        "url": "mailto:noreply@dealcloud.com",
        "type": 0,
        "id": 8278,
        "name": "FirstName LastName",
        "entryListId": -1
      },
      "NotesAdded": {
        "seqNumber": 2,
        "isAutoPdf": false,
        "id": 1186,
        "name": "Missing Notes",
        "entryListId": -6
      },
      "CreatedBy": {
        "url": "mailto:noreply@dealcloud.com",
        "type": 0,
        "id": 8278,
        "name": "FirstName LastName",
        "entryListId": -1
      },
      "ModifiedBy": {
        "url": "mailto:noreply@dealcloud.com",
        "type": 0,
        "id": 8278,
        "name": "FirstName LastName",
        "entryListId": -1
      },
      "CreatedDate": "2020-12-31T01:18:13.517Z",
      "ModifiedDate": "2021-04-26T13:27:34.263Z"
    }
  ]
}

Sample Filtering

For a full guide on filtering, see Filter Operations.

Filter on EntryId

{
  "query": "{entryid: 2553146}",
  "limit": 1,
  "skip": 0,
  "wrapIntoArrays": true
}

Rows Get