Skip to main content
GET
/
dashboards
List dashboards
curl --request GET \
  --url https://app.azalt.co/api/v1/dashboards \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "organizationId": "<string>",
    "isPublic": true,
    "publicCanFilterSites": true,
    "order": 123,
    "globalFilter": {
      "siteIds": [
        "<string>"
      ],
      "startYear": 123,
      "endYear": 123,
      "startDate": "<string>",
      "endDate": "<string>",
      "statuses": [
        "COMPLETED"
      ]
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "kpis": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "hasPassword": true,
    "requiresEmail": true,
    "publicAccessEmails": [
      "jsmith@example.com"
    ],
    "publicAccessDomains": [
      "<string>"
    ],
    "organizationDefaultStatuses": [
      "COMPLETED"
    ],
    "tags": [
      "<string>"
    ]
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.azalt.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful response

id
string
required
name
string
required
description
string | null
required
organizationId
string
required
isPublic
boolean
required
publicCanFilterSites
boolean
required
order
number
required
globalFilter
object
required
createdAt
string
required
updatedAt
string
required
kpis
object[]
required
hasPassword
boolean
requiresEmail
boolean
publicAccessEmails
string<email>[] | null
publicAccessDomains
string[] | null
Pattern: ^(?!-)(?:[a-z0-9-]{1,63}\.)+[a-z]{2,63}$
organizationDefaultStatuses
enum<string>[]
Available options:
COMPLETED,
APPROVED,
REJECTED
tags
string[] | null