List templates

GET

/v2/templates

GET

/v2/templates

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

200Retrieved

1 {
2   "entries": [
3     {
4       "templateId": "tpl_9f8e7d6c5b4a3210",
5       "templateUrlId": "sales_dashboard_2024",
6       "name": "Sales Performance Dashboard",
7       "url": "https://app.sigmacomputing.com/templates/sales_dashboard_2024",
8       "path": "/templates/sales/performance_dashboard",
9       "latestVersion": 3.2,
10       "createdBy": "SigmaSchedulerRobot",
11       "updatedBy": "SigmaSchedulerRobot",
12       "createdAt": "2024-01-15T09:30:00Z",
13       "updatedAt": "2024-04-10T14:45:00Z",
14       "isArchived": false,
15       "tags": [
16         {
17           "versionTagId": "v3.2",
18           "name": "stable"
19         },
20         {
21           "versionTagId": "beta_2024Q2",
22           "name": "beta"
23         }
24       ]
25     }
26   ],
27   "nextPage": "eyJwYWdlIjoiMg==",
28   "total": 25,
29   "hasMore": true
30 }

Returns a list of available templates.

Usage notes

Official Sigma templates are created by SigmaSchedulerRobot.

Returns a list of available templates. ### Usage notes - Official Sigma templates are created by SigmaSchedulerRobot.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pagestringOptional

limitdoubleOptional

sourceenumOptional

Filters results to templates based on their source. Set to internal to only retrieve templates created within your organization. Set to external to only retrieve templates shared to your organization. Do not specify a source to list all templates regardless of their source.

Allowed values:

searchstringOptional

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.