List account types

GET

/v2/accountTypes

GET

/v2/accountTypes

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

200Retrieved

1 {
2   "entries": [
3     {
4       "accountTypeId": "admin-001",
5       "accountTypeName": "Admin",
6       "description": "Full access to all features and settings within the organization.",
7       "isCustom": false
8     },
9     {
10       "accountTypeId": "editor-002",
11       "accountTypeName": "Editor",
12       "description": "Can create and modify content but has limited access to administrative settings.",
13       "isCustom": false
14     },
15     {
16       "accountTypeId": "viewer-003",
17       "accountTypeName": "Viewer",
18       "description": "Read-only access to view reports and dashboards without editing capabilities.",
19       "isCustom": false
20     },
21     {
22       "accountTypeId": "custom-101",
23       "accountTypeName": "Custom Analyst",
24       "description": "Custom role with permissions tailored for advanced data analysis and report generation.",
25       "isCustom": true
26     }
27   ],
28   "nextPageToken": "eyJwYWdlIjoxfQ=="
29 }

Returns a list of all account types available in the organization.

Usage notes

Use the accountTypeId with the /v2/accountTypes/:accountTypeId/permissions endpoint to retrieve more detailed permissions.
To perform this operation, you must use API credentials owned by a user assigned the Admin account type.

Usage scenarios

Display available account types in an admin interface.
Show an overview of account types for management.

Returns a list of all account types available in the organization. ### Usage notes - Use the **accountTypeId** with the [/v2/accountTypes/:accountTypeId/permissions](https://help.sigmacomputing.com/reference/list-account-type-permissions) endpoint to retrieve more detailed permissions. - To perform this operation, you must use API credentials owned by a user assigned the Admin account type. ### Usage scenarios - Display available account types in an admin interface. - Show an overview of account types for management.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pageTokenstringOptional

pageSizeintegerOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPageTokenstring

A string that can be passed to the pageToken parameter in the next request to fetch the next page of results. Not present in the last page of results. Must be treated as an opaque string.