Get view state for a collection. | Scout API & SDK Reference

{
  "success": true,
  "data": {
    "organization_id": "org_987654321",
    "collection_id": "col_123456789",
    "views": {
      "view_01": {
        "id": "view_01",
        "name": "All Items",
        "type": "grid",
        "filters": [
          {
            "field": "status",
            "operator": "equals",
            "value": "active"
          }
        ],
        "sort": [
          {
            "field": "created_at",
            "direction": "desc"
          }
        ]
      },
      "view_02": {
        "id": "view_02",
        "name": "Completed Tasks",
        "type": "kanban",
        "filters": [
          {
            "field": "status",
            "operator": "equals",
            "value": "completed"
          }
        ],
        "sort": [
          {
            "field": "due_date",
            "direction": "asc"
          }
        ]
      }
    },
    "view_ids": [
      "view_01",
      "view_02"
    ],
    "active_view_id": "view_01",
    "active_table_id": "table_12345",
    "display_settings": {
      "theme": "light",
      "show_row_numbers": true,
      "page_size": 50
    },
    "last_synced_at": "2024-01-15T09:30:00Z",
    "created_at": "2023-11-20T08:15:00Z",
    "updated_at": "2024-01-10T16:45:00Z"
  },
  "error": ""
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_idstringRequired

Response

Successful Response

successboolean

dataobject or nullOptional

Complete view state for a collection

errorstring or nullOptional

Errors

422

Unprocessable Entity Error

$	curl https://api.scoutos.com/v2/collections/collection_id/views \
>	-H "Authorization: Bearer <token>"