List Views
GET {{host}}/api/rest/v4/data/rows/view
Authorization: Bearer {{token}}Get a list of views
Params
| Name | Parameter Type | Data Type | Values | Description |
|---|---|---|---|---|
| query | Query Parameter | string | Compan | Search string like 'Compan' |
| isPrivate | Query Parameter | boolean | true | Returns only private views |
| limit | Query Parameter | integer | 20 | See Pagination for details |
| skip | Query Parameter | integer | 20 | See Pagination for details |
Additional Requirements
- Search string is a simple string like 'Compa' to search for anything similar to 'Companies', 'My Company', or 'Companion'
- Search string is applied to the view name as well as the name of the primary list object
- Search string needs to be URL encoded if there are any special characters in the string.
- When skip and limit are not included as parameters, default values of 0 and 1000 are applied respectively
- Make sure to use proper Pagination to fetch all records as required.
Sample Requests and Responses
List views.
GET {{host}}/api/rest/v4/data/rows/view?skip=0&limit=1000
Authorization: Bearer {{token}}Response
{
"totalRecords": 11,
"rows": [
{
"id": 1,
"name": "Companies - All Targets",
"primaryLists": [
{
"id": 2014,
"name": "Company",
"entryListId": 0
}
],
"optionalParameters": [
{
"columnId": 8,
"columnName": "Watchlist?",
"defaultValue": [
1105
]
}
]
},
{
"id": 2,
"name": "Companies - Non Target",
"primaryLists": [
{
"id": 2014,
"name": "Company",
"entryListId": 0
}
],
"optionalParameters": []
},
{
"id": 3,
"name": "Investors",
"primaryLists": [
{
"id": 2014,
"name": "Company",
"entryListId": 0
}
],
"optionalParameters": []
}
]
}