For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Scout DocsAccess Scout
API & SDK
API & SDK
  • Endpoints
      • GETList all collections.
      • POSTCreate a collection.
      • GETGet a collection by ID.
      • PUTUpdate a collection by ID.
      • DELDelete a collection by ID.
      • GETGet all syncs for a given collection
      • GETGet view state for a collection.
      • PUTUpdate view state for a collection.
      • DELDelete view state for a collection.
      • GETList individual views for a collection.
      • POSTCreate an individual view.
      • PUTUpdate an individual view.
      • DELDelete an individual view.
LogoLogo
Scout DocsAccess Scout
EndpointsCollections

Get view state for a collection.

Beta
GET
https://api.scoutos.com/v2/collections/:collection_id/views
GET
/v2/collections/:collection_id/views
$curl https://api.scoutos.com/v2/collections/collection_id/views \
>     -H "Authorization: Bearer <token>"
1{
2  "success": true,
3  "data": {
4    "organization_id": "org_987654321",
5    "collection_id": "col_123456789",
6    "views": {
7      "view_01": {
8        "id": "view_01",
9        "name": "All Items",
10        "type": "grid",
11        "filters": [
12          {
13            "field": "status",
14            "operator": "equals",
15            "value": "active"
16          }
17        ],
18        "sort": [
19          {
20            "field": "created_at",
21            "direction": "desc"
22          }
23        ]
24      },
25      "view_02": {
26        "id": "view_02",
27        "name": "Completed Tasks",
28        "type": "kanban",
29        "filters": [
30          {
31            "field": "status",
32            "operator": "equals",
33            "value": "completed"
34          }
35        ],
36        "sort": [
37          {
38            "field": "due_date",
39            "direction": "asc"
40          }
41        ]
42      }
43    },
44    "view_ids": [
45      "view_01",
46      "view_02"
47    ],
48    "active_view_id": "view_01",
49    "active_table_id": "table_12345",
50    "display_settings": {
51      "theme": "light",
52      "show_row_numbers": true,
53      "page_size": 50
54    },
55    "last_synced_at": "2024-01-15T09:30:00Z",
56    "created_at": "2023-11-20T08:15:00Z",
57    "updated_at": "2024-01-10T16:45:00Z"
58  },
59  "error": ""
60}
Was this page helpful?
Previous

Update view state for a collection.

Next
Built with

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 null
Complete view state for a collection
errorstring or null

Errors

422
Unprocessable Entity Error