Query – DealCloud API Docs

Query Data

Returns entry data as object, supports large queries

Swagger

Params

name	Parameter type	Data Type	Values	Description
entryTypeId	Path	string or int	company or 2011	the unique identifier of the entry type
query	Query	query syntax	FilterOperations	use filter query syntax
fields	Query	Array[string]	fields=firstName	Can specify a subset of fields, if left blank all fields are returned
limit	Query	int	1000	Can specify the maximum number of entries to return, useful for paging 1000 suggested max
skip	Query	int	1000	When paging skip sets the paging start
resolveReferenceUrls	Query	boolean	false	Returns URL of entry if true
wrapIntoArrays	Query	boolean	true	Set to true to improve consistency of multi value fields

Model

{
  "totalRecords": 1,
  "rows": [Entries]
}

Entries - Will always include the EntryId, may include 1 or more fields. Field serialization depends on the Field Type.

{
  "EntryId" (integer, required),
  "fieldApiName" (object, required)
}

Requests

All Fields all records

The simplest requests, no queries, returns all fields and all records for a given entry type.

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

Filtered records

Filter on EntryID equals, returns all fields:

POST {{host}}/api/rest/v4/data/entrydata/rows/query/{{entryTypeId}} HTTP/1.1
Authorization: {{auth}}
Content-Type: application/json
 
{
  "query": "{entryid: 3047024}",
  "limit": 1,
  "skip": 0,
  "resolveReferenceUrls": true,
  "wrapIntoArrays": true
}

Filter on excluding records with a specific reference value:

{
  "query": "{CoveragePerson: {$nin: [5785]}}",
  "fields": ["Subject", "Date"],
  "limit": 1,
  "skip": 0,
  "resolveReferenceUrls": true,
  "wrapIntoArrays": true
}

Filter using Or:

{
  "query": "{$or: [{CompanyName: \"DealCloud\"},{CompanyName: \"API Entry\"}]}",
  "resolveReferenceUrls": true,
  "wrapIntoArrays": true
}

Filter using DateTime, time components are ignored. If you wish to run a Delta Query use the History endpoint instead, the history endpoint will return entries that were modified/deleted from a given Datetime and resolves to the nearest second.:

{
  "query": "{\"ModifiedDate\": {$gte: \"2020-04-12T19:44:35.491Z\"}}",
  "resolveReferenceUrls": true,
  "wrapIntoArrays": true
}

Specify specific fields to return:

{
  "fields": ["Subject", "Date"],
  "resolveReferenceUrls": true,
  "wrapIntoArrays": true
}

Specify number of records to return:

{
  "limit": 1000,
  "resolveReferenceUrls": true,
  "wrapIntoArrays": true
}

Specify number of records to skip:

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

Responses

HTTP/1.1 200 OK
{
  "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"
    }
  ]
}

Get Create