List custom views (experimental)

GET

https://api.agentpaid.io/api/v2/experimental/views/

GET

/api/v2/experimental/views/

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.customViewsExperimental.listCustomViews();
8 }
9 main();

1 {
2   "views": [
3     {
4       "displayId": "view_9f8b7c6d",
5       "name": "Monthly Sales Overview",
6       "description": "Summary of monthly sales performance across all regions.",
7       "status": "PUBLISHED",
8       "queryCount": 5,
9       "period": {
10         "kind": "relative",
11         "unit": "month",
12         "amount": 3
13       },
14       "createdAt": "2024-05-10T09:15:00.000Z",
15       "scope": "organization"
16     },
17     {
18       "displayId": "view_4a3d2e1f",
19       "name": "Customer Engagement Q2",
20       "description": "Engagement metrics for Q2 2024.",
21       "status": "DRAFT",
22       "queryCount": 3,
23       "period": {
24         "kind": "absolute",
25         "start": "2024-04-01",
26         "end": "2024-06-30"
27       },
28       "createdAt": "2024-06-01T14:45:00.000Z",
29       "scope": "customer"
30     }
31   ]
32 }

⚠️ Experimental — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.

Lists the organization’s custom views (newest first) with lightweight summary info — name, status, query count, default date range, created date. Does not return the SQL or render bundle; fetch a single view via getCustomView for those.

⚠️ **Experimental** — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet. Lists the organization's custom views (newest first) with lightweight summary info — name, status, query count, default date range, created date. Does not return the SQL or render bundle; fetch a single view via getCustomView for those.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Response

200

viewslist of objects

Errors

403

Forbidden Error

500

Internal Server Error