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

List individual views for a collection.

Beta
GET
https://api.scoutos.com/v2/collections/:collection_id/views/list
GET
/v2/collections/:collection_id/views/list
$curl https://api.scoutos.com/v2/collections/collection_id/views/list \
>     -H "Authorization: Bearer <token>"
1{
2  "success": true,
3  "data": [
4    {
5      "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
6      "name": "Monthly Sales Overview",
7      "emoji": "📊",
8      "table_id": "tbl_9876543210abcdef",
9      "collection_id": "col_1234567890abcdef",
10      "created_at": "2024-01-15T09:30:00Z",
11      "updated_at": "2024-04-10T14:45:00Z",
12      "created_by": "user_00123",
13      "last_updated_by": "user_00456",
14      "visibility": "personal",
15      "shared_with": [
16        "user_00789",
17        "user_00234"
18      ],
19      "filters": [
20        {
21          "id": "flt_abc123def456",
22          "column_id": "col_revenue",
23          "operator": "equals",
24          "value": 10000,
25          "enabled": true,
26          "created_at": "2024-01-15T09:30:00Z"
27        }
28      ],
29      "query": {
30        "global_search": "Q1 performance",
31        "sort_by": [
32          {
33            "column_id": "col_date",
34            "direction": "asc"
35          }
36        ],
37        "limit": 50,
38        "offset": 0
39      },
40      "type": "table",
41      "settings": {
42        "column_visibility": {
43          "col_date": true,
44          "col_revenue": true,
45          "col_region": false
46        },
47        "column_order": [
48          "col_date",
49          "col_revenue",
50          "col_region"
51        ],
52        "column_widths": {
53          "col_date": 150,
54          "col_revenue": 120,
55          "col_region": 100
56        },
57        "type": "table",
58        "row_height": "medium",
59        "show_row_numbers": true,
60        "wrap_text": true,
61        "filters": [
62          {
63            "id": "flt_abc123def456",
64            "column_id": "col_revenue",
65            "operator": "equals",
66            "value": 10000,
67            "enabled": true,
68            "created_at": "2024-01-15T09:30:00Z"
69          }
70        ]
71      }
72    }
73  ],
74  "error": ""
75}
Was this page helpful?
Previous

Create an individual view.

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
datalist of objects or null
errorstring or null

Errors

422
Unprocessable Entity Error