list_dashboards

DashboardsApi.list_dashboards(role_id, projection_expression=None, offset=None, limit=None, sortorder=None, sortby=None, filter_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List user-accessible dashboards

Returns a paginated list of dashboards the authenticated user can access with AccessType owner, editor, or read-only. A valid role_id header is required for authorization (list itself does not require a dashboards.* role permission beyond role membership). Supports filtering, sorting, and field projection. This Lambda maps InvalidInputException to HTTP 422, UnauthorizedUserException (resource ACL) to HTTP 401, RequestValidationError to HTTP 400, and unhandled/GenericFailure to HTTP 500. Pagination uses offset and limit over an in-memory sorted page. Default offset is 0 and default limit is 100 (maximum 1000). Results include next_available (“yes” or “no”), count (page size), and total_count. Stop requesting further pages when next_available is “no”. An offset past the end of the filtered list returns an empty page with next_available “no”. Example: GET /dashboards?limit=25&offset=0&sortby=LastModifiedTime&sortorder=desc

Parameters:

• role_id (str) – Amorphic role ID used to authorize the request. Must be a role the authenticated user belongs to. Resource access for the list itself is resolved from the user identity, not from role_id alone. (required)

• projection_expression (str) – Comma-separated list of dashboard attributes to include in each item. When omitted, a default field set is returned (Widgets, CreatedBy, CreationTime, Keywords, and origin are omitted).

• offset (str) – Zero-based index of the first item to return. Values beyond the filtered list length return an empty page with next_available “no”.

• limit (str) – Maximum number of dashboards to return per page. Maximum allowed is 1000.

• sortorder (str) – Sort direction. Use asc or desc. At runtime, any value other than desc is treated as ascending.

• sortby (str) – Dashboard attribute to sort by. The attribute must exist on returned items or sorting fails.

• filter_expression (str) – Comma-separated field:value pairs applied before pagination. Format: key:value,key:value. DashboardName supports wildcard matching; other fields use exact match.

• _request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

• _content_type (str, Optional) – force content-type for the request.

• _headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.

• _host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

DashboardListResponseBody

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /dashboards

Parameter examples

Name	In	Example
role_id	header	"custom-role-123e4567-e89b-12d3-a456-426614174000"
projectionExpression	query	"DashboardId,DashboardName,AccessType,LastModifiedTime"
offset	query	"0"
limit	query	"25"
sortorder	query	"desc"
sortby	query	"LastModifiedTime"
filterExpression	query	"DashboardName:Q1_Sales"

Success (HTTP 200)

Paginated list of accessible dashboards. When next_available is “no”, the caller has reached the last page.

Request / response example

{
  "dashboards": [
    {
      "DashboardId": "b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f",
      "DashboardName": "Sales Overview",
      "DashboardDescription": "Monthly sales KPIs",
      "LastModifiedTime": "2026-08-01 10:15:00",
      "LastModifiedBy": "jane.doe",
      "AccessType": "owner",
      "CustomUrlPath": "SalesOverview-3c4d5e6f"
    }
  ],
  "next_available": "no",
  "count": 1,
  "total_count": 1
}

Errors

Documented error codes: AUTH-1001, AUTH-1030, GE-1004.

HTTP 400

Invalid input or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Common codes include AUTH-1001 (missing role_id) and IPV-* validation failures.

missingRole

{
  "Message": "AUTH-1001 - Missing role information in event header"
}

HTTP 422

InvalidInputException such as AUTH-1001 (missing role_id) or AUTH-1030 (role permission failure). Body is {“Message”: “<CODE> - <text>”}.

missingRole

{
  "Message": "AUTH-1001 - Missing role information in event header"
}

HTTP 500

Backend/generic failure. Body is {“Message”: “<CODE> - <text>”}.

Unexpected backend failure

{
  "Message": "GE-1004 - Unexpected error - <exception text>"
}