Get Records for View

GET

https://app.smartsuite.com/api/v1/applications/[tableId]/records-for-report/?report=[reportId]&with_empty_values=false

Gets the records for a specified View.

Example Request

curl -X GET "https://app.smartsuite.com/api/v1/applications/[tableId]/records-for-report/?report=[reportId]&with_empty_values=false" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "ACCOUNT-ID: WORKSPACE_ID" \
  -H "Content-Type: application/json"

Query Parameters

Param	Type	Description
report	string	The View Id. Required.
with_empty_values	boolean	Optional. Include fields whose value is empty instead of omitting them. Defaults to false.

Response

Param	Type	Description
records	array of record objects	An array containing SmartSuite record objects
related_records	array of objects	Records referenced by linked record fields, each as {id, title, application_id, application_slug}
fields	array of strings	An array containing the field slugs visible in the View
filter	filter object	The filter applied to the view, if any
unfiltered	boolean	true if the View has no filter applied
sort	array of sort objects	The sort applied to the View, if any
total_records_count	number	Total number of records matching the View, before any paging
lazy_fields	array of strings	Slugs of fields the View loads on demand rather than up front

Example Response

{
    "records": [
        {
            "first_created": {
                "by": "63a1f65723aaf6bcb564b1f1",
                "on": "2023-01-06T20:00:15.470000Z"
            },
            "last_updated": {
                "by": "63a1f65723aaf6bcb564b1f1",
                "on": "2023-01-06T20:00:15.470000Z"
            },
            "autonumber": 1,
            "title": "Sample record",
            "comments_count": 0,
            "deleted_date": {
                "date": null,
                "include_time": false
            },
            "ranking": {
                "default": "aagckvjtea"
            },
            "assigned_to": [],
            "status": {
                "value": "backlog",
                "updated_on": "2023-01-06T20:00:15.470000Z"
            },
            "due_date": {
                "from_date": {
                    "date": null,
                    "include_time": false
                },
                "to_date": {
                    "date": null,
                    "include_time": false
                },
                "is_overdue": false,
                "status_is_completed": false,
                "status_updated_on": "2023-01-06T20:00:15.470000Z"
            },
            "priority": "",
            "id": "63b87dcf7acde19eac1fe42a",
            "application_slug": "ssb9kaxn",
            "application_id": "63b87cad645b3949631b55c1"
        },
        {
            "first_created": {
                "by": "63a1f65723aaf6bcb564b1f1",
                "on": "2023-06-21T21:14:06.247000Z"
            },
            "last_updated": {
                "by": "63a1f65723aaf6bcb564b1f1",
                "on": "2023-06-21T21:14:06.247000Z"
            },
            "autonumber": 2,
            "title": "test",
            "comments_count": 0,
            "deleted_date": {
                "date": null,
                "include_time": false
            },
            "ranking": {
                "default": "aagckvkhyq"
            },
            "assigned_to": [],
            "status": {
                "value": "backlog",
                "updated_on": "2023-06-21T21:14:06.248000Z"
            },
            "due_date": {
                "from_date": {
                    "date": null,
                    "include_time": false
                },
                "to_date": {
                    "date": null,
                    "include_time": false
                },
                "is_overdue": false,
                "status_is_completed": false,
                "status_updated_on": "2023-06-21T21:14:06.248000Z"
            },
            "priority": "",
            "id": "6493681eba09b400816eb754",
            "application_slug": "ssb9kaxn",
            "application_id": "63b87cad645b3949631b55c1"
        }
    ],
    "related_records": [],
    "fields": [
        "title",
        "due_date",
        "comments_count",
        "status",
        "priority",
        "assigned_to"
    ],
    "filter": {},
    "unfiltered": true
}