Get – DealCloud API Docs

Get Data

Returns entry data as objects. For complex quering, it is recommended that you use the Query endpoint instead, as this endpoint has a query string limit of 2040 characters.

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. Use for pagination (suggested limit: 1000)
skip	Query	int	1000	When paging, skip sets the paging start. This number must be divisible by `limit`
resolveReferenceUrls	Query	boolean	false	Returns URL of entry
wrapIntoArrays	Query	boolean	true	Set to true to improve consistency of multi value fields
fillExtendedData	Query	boolean	false	Deprecated for Rows API

Response Model

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

TotalRecords - TotalRecords indicates the number of records matching your query. This number can be used to determine how many requests are needed to get all records.

Rows - This contains the actual data return as an array of objects.

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)
}

Sample Requests

All Fields, all records

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

GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
  ?wrapIntoArrays=true HTTP/1.1

Filtered records

Filter on EntryID:

GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
  ?wrapIntoArrays=true&query={"EntryId": 2553146} HTTP/1.1

Filter on excluding records with a specific reference value:

GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
  ?wrapIntoArrays=true&query={"CoveragePerson": {$nin: [5785]}} HTTP/1.1

Filter using Or:

GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
  ?wrapIntoArrays=true&query={$or: [{CompanyName: "DealCloud"},{CompanyName: "API Entry"}]} HTTP/1.1

Filter using DateTime

Time components are ignored. If you wish to run a Delta Query, use the History endpoint or the All History endpoint instead. Theese endpoint will return entries that were modified/deleted from a given Datetime and resolves to the nearest second.

GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
  ?wrapIntoArrays=true&query={"ModifiedDate": {$gte: "2020-04-12T19:44:35.491Z"}} HTTP/1.1

Specify specific fields to return:

GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
  ?wrapIntoArrays=true&fields=CompanyName&fields=Type HTTP/1.1

Specify number of records to return:

GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
  ?wrapIntoArrays=true&limit=1 HTTP/1.1

Specify number of records to skip:

GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
  ?wrapIntoArrays=true&skip=500&limit=500 HTTP/1.1

Sample 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"
    }
  ]
}

Models Data Entry Data Data Reference Data Data Text Data Data Number Data Data Currency Data Data Choice Data

Rows Query