Get Data
GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}
Authorization: Bearer {{token}}
The main differences between using this endpoint versus the Query endpoint is that parameters are included on the URL path with a GET method. When using the query endpoint, the parameters are sent in the body of a POST request. Refer to the Query endpoint for more complex filtering.
The URL path has a maximum character limit of 2040 characters.
Params
Name | Parameter Type | Data Type | Values | Description |
---|---|---|---|---|
entryTypeId | Path | string/int | company or 2011 | Unique identifier of the object or it's name. |
query | Query Parameter | string | Filter Operations | Filter query syntax |
fields | Query Parameter | string | firstName | Specify a subset of fields. |
limit | Query Parameter | int | 1000 | See Pagination for details |
skip | Query Parameter | int | 0 | See Pagination for details |
resolveReferenceUrls | Query Parameter | boolean | false | If true, returns URL of entry for reference fields |
wrapIntoArrays | Query Parameter | boolean | true | Improves consistency for multi-value fields |
dateTimeBehavior | Query Parameter | 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 |
Additional Requirements
- Query string needs to be URL encoded if there are any special characters in the string.
- See Filter Operations for details
Examples
Using proper pagination, returns all fields and records for a given entry type.
Request
GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}?wrapIntoArrays=true&skip=0&limit=1000
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
GET {{host}}/api/rest/v4/data/entrydata/rows/{{entryTypeId}}?wrapIntoArrays=true&query={"EntryId":2553146}