> ## Documentation Index > Fetch the complete documentation index at: https://developers.torq.io/llms.txt > Use this file to discover all available pages before exploring further. # List dashboards > Returns the dashboards the API key can see: organization dashboards, dashboards shared with all users, and private or selected dashboards that the API key's user owns or is included in. A service account key sees only the first two. To see every dashboard in the workspace, use an API key whose role includes the `Bypass cases dashboard restriction` permission. The Account Owner role includes it. ## OpenAPI ````json GET /v1alpha/dashboards { "openapi": "3.0.1", "info": { "contact": { "email": "support@torq.io", "name": "torq.io", "url": "https://torq.io" }, "title": "Torq Public API[production]", "version": "${DH_DEPLOY_VERSION}" }, "servers": [ { "url": "https://api.torq.io/public", "description": "US Environment" }, { "url": "https://api.eu.torq.io/public", "description": "European Enviornment" } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Files" }, { "name": "ActivityLogs" }, { "name": "AgentsHubService" }, { "name": "Users" }, { "name": "ApiKeys" }, { "name": "AuditLogs" }, { "name": "ContextGraph" }, { "name": "DashboardsService" }, { "name": "Executions" }, { "name": "ShareRequests" }, { "name": "StepRunners" }, { "name": "Integrations" }, { "name": "IPAccessService" }, { "name": "RolesService" }, { "name": "ScheduledReportsService" }, { "name": "Secrets" }, { "name": "SecuritySettingsService" }, { "name": "ClaimMappings" }, { "name": "IdpSsoService" }, { "name": "Workflows" }, { "name": "Workspaces" }, { "name": "WorkspaceVariables" }, { "name": "Auto Triage Alerts" }, { "name": "Auto Triage Guidance" }, { "name": "Auto Triage Alert History" }, { "name": "Auto Triage Rules" }, { "name": "Auto Triage Verdict Actions" }, { "name": "Cases" }, { "name": "Cases Custom Fields" }, { "name": "Cases Notes" }, { "name": "ExtendedCaseService" }, { "name": "Cases Attachments" }, { "name": "Observables" }, { "name": "Cases Observables" }, { "name": "CaseSearchService" }, { "name": "Cases Tasks" }, { "name": "Cases Task Templates" }, { "name": "Cases Links" }, { "name": "Cases Events" }, { "name": "Cases Runbooks" } ], "externalDocs": { "description": "Torq Documentation", "url": "https://learn.torq.io" }, "x-original-swagger-version": "2.0", "paths": { "/v1alpha/dashboards": { "get": { "description": "Returns the dashboards the API key can see: organization dashboards, dashboards shared with all users, and private or selected dashboards that the API key's user owns or is included in. A service account key sees only the first two. To see every dashboard in the workspace, use an API key whose role includes the `Bypass cases dashboard restriction` permission. The Account Owner role includes it.", "operationId": "listDashboards", "parameters": [ { "description": "Return only dashboards whose title contains this text. The match is case-insensitive.", "in": "query", "name": "title", "schema": { "type": "string" } }, { "description": "Return only the dashboard with this ID. The response then includes the dashboard's access entries, if it has any. An ID that does not exist, or that the API key cannot see, returns an empty list.", "in": "query", "name": "id", "schema": { "type": "string" } }, { "description": "The criteria by which to sort the results. The only possible value is `created_at`. By default, organization dashboards are listed first, then the rest by creation time.", "in": "query", "name": "order_by", "schema": { "type": "string" } }, { "description": "The order in which to sort the results when `order_by` is set. The possible values are: `asc` for ascending, and `desc` for descending. Default is `asc`.", "in": "query", "name": "order", "schema": { "default": "asc", "type": "string" } }, { "description": "The maximum number of dashboards to retrieve per page. Default is 100. Maximum is 500.\nIf the number of results exceeds the defined page size, use [pagination](https://learn.torq.io/apidocs/pagination) to retrieve the next page of results.", "in": "query", "name": "page_size", "schema": { "default": 100, "format": "int32", "type": "integer" } }, { "description": "The token received from a previous `List dashboards` request. Provide this to retrieve the next page of results. Send the same filters and sort as the request that returned it.", "in": "query", "name": "page_token", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v1alphaListDashboardsResponse" } } }, "description": "A successful response." }, "401": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token." }, "403": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "You don't have permission to access this resource." } }, "summary": "List dashboards", "tags": [ "Dashboards" ] } } }, "components": { "schemas": { "v1alphaListDashboardsResponse": { "properties": { "dashboards": { "description": "The dashboards that match the request.", "items": { "$ref": "#/components/schemas/v1alphaDashboard" }, "type": "array" }, "next_page_token": { "description": "When a token is returned it indicates there is another page of results to retrieve. Pass this token in the page_token parameter in a subsequent `List dashboards` request to retrieve the next page of results. If this field is not returned, there are no additional pages to retrieve.", "title": "Next page token", "type": "string" } }, "title": "List dashboards response", "type": "object" }, "v1alphaDashboard": { "description": "A dashboard in the workspace.", "properties": { "id": { "description": "The unique identifier of the dashboard.", "example": "0f8fad5b-d9cb-469f-a165-70867728950e", "readOnly": true, "type": "string" }, "title": { "description": "The dashboard title.", "example": "SOC overview", "readOnly": true, "type": "string" }, "description": { "description": "The dashboard description.", "example": "Open cases by severity and assignee", "readOnly": true, "type": "string" }, "is_org_dashboard": { "description": "Whether this is an organization dashboard, shared from the organization to its workspaces.", "readOnly": true, "type": "boolean" }, "access_type": { "description": "Who can see the dashboard. The possible values are: `all_users` for everyone in the workspace, `private` for only its owner, `selected` for the users, groups, or workspaces in `access_entries`, and `organization` for every workspace in the organization.", "example": "selected", "readOnly": true, "type": "string" }, "access_entries": { "description": "The users, groups, and workspaces the dashboard is shared with. For a private dashboard, the owner. Returned only by `List dashboards` when filtering by `id`, and by `Update dashboard access`.", "items": { "$ref": "#/components/schemas/v1alphaAccessEntry" }, "readOnly": true, "type": "array" }, "widget_count": { "description": "The number of widgets on the dashboard.", "example": 6, "format": "int32", "readOnly": true, "type": "integer" }, "created_at": { "description": "The timestamp when the dashboard was created.", "format": "date-time", "readOnly": true, "type": "string" }, "created_by": { "$ref": "#/components/schemas/apidashboardsv1alphaActor" }, "updated_at": { "description": "The timestamp when the dashboard was last updated. If the dashboard has never been updated, this is its creation time and `updated_by` is not returned.", "format": "date-time", "readOnly": true, "type": "string" }, "updated_by": { "$ref": "#/components/schemas/apidashboardsv1alphaActor" }, "url": { "description": "A link that opens the dashboard in Torq.", "example": "https://app.torq.io/v3/dashboards/0f8fad5b-d9cb-469f-a165-70867728950e?account=my-account", "readOnly": true, "type": "string" } }, "type": "object" }, "v1alphaAccessEntry": { "description": "Contains a user, group, or workspace that can see a dashboard.", "properties": { "type": { "description": "The kind of entry. The possible values are: `user`, `group`, `workspace`. Only `user` and `group` can be set through `Update dashboard access`.", "example": "user", "type": "string" }, "value": { "description": "The user's email address, the group ID, or the workspace ID.", "example": "dana@example.com", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "apidashboardsv1alphaActor": { "description": "Contains the user, API key, workflow, integration, agent, or system that performed an action.", "properties": { "type": { "description": "The kind of actor. The possible values are: `user`, `service_api_key`, `workflow`, `integration`, `agent`, `system`.", "example": "user", "readOnly": true, "type": "string" }, "email": { "description": "The user's email address. Set when `type` is `user`.", "example": "dana@example.com", "readOnly": true, "type": "string" }, "name": { "description": "The user's full name, the API key name, the workflow name or the integration type, when known.", "example": "Dana Levi", "readOnly": true, "type": "string" }, "id": { "description": "The API key client ID, the workflow ID, the integration ID or the agent ID, when applicable.", "readOnly": true, "type": "string" } }, "type": "object" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "64fb4b65-44d8-4304-881c-b1f8b6b3100a" } } } } ````