List workbooks for a tag

GET

/v2/tags/:tagId/workbooks

GET

/v2/tags/:tagId/workbooks

$ curl https://api.sigmacomputing.com/v2/tags/tagId/workbooks \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "workbookId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
5       "workbookUrlId": "sales_performance_q1_2024",
6       "name": "Sales Performance Q1 2024",
7       "url": "https://app.sigmacomputing.com/workbooks/sales_performance_q1_2024",
8       "path": "/Sales/2024/Q1",
9       "latestVersion": 3.2,
10       "ownerId": "user_987654321",
11       "createdBy": "user_123456789",
12       "updatedBy": "user_987654321",
13       "createdAt": "2024-01-15T09:30:00Z",
14       "updatedAt": "2024-04-10T14:45:00Z",
15       "isArchived": false,
16       "tags": [
17         {
18           "versionTagId": "tag_2024_q1_release",
19           "name": "Q1 Release",
20           "sourceWorkbookVersion": 3.2,
21           "taggedWorkbookId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
22           "workbookTaggedAt": "2024-04-10T15:00:00Z"
23         }
24       ],
25       "description": "Workbook showing sales performance metrics for Q1 2024."
26     }
27   ],
28   "nextPage": null,
29   "total": 1,
30   "hasMore": false
31 }

Get a list of workbooks for a specific version tag. Retrieve the tagId by calling the /v2/tags endpoint and using the versionTagId in the response.

Get a list of workbooks for a specific version tag. Retrieve the **tagId** by calling the [/v2/tags](https://help.sigmacomputing.com/reference/list-version-tag) endpoint and using the `versionTagId` in the response.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

tagIdstringRequired

Query parameters

pagestringOptional

limitdoubleOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPagestring or null

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totaldouble

Total number of results. Useful to determine if there is a need to paginate.

hasMoreboolean

[Deprecated] Indicates whether more results are available.