Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
services
/
dashboardServices
GET /v1/services/dashboardServices
from metadata.sdk import configure
import requests

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List dashboard services
response = requests.get(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices?limit=50",
    headers={"Authorization": "Bearer your-jwt-token"}
)

result = response.json()
for svc in result["data"]:
    print(f"{svc['fullyQualifiedName']} ({svc['serviceType']})")

# With fields
response = requests.get(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices?fields=owners,tags,domains&limit=50",
    headers={"Authorization": "Bearer your-jwt-token"}
)
{
  "data": [
    {
      "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
      "name": "sample_looker",
      "fullyQualifiedName": "sample_looker",
      "serviceType": "Looker",
      "version": 0.1,
      "updatedAt": 1769982621219,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
      "deleted": false,
      "owners": [],
      "tags": [],
      "domains": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

List Dashboard Services

List all dashboard services with optional filtering and pagination.

Query Parameters

limit
integer
default:"10"
Maximum number of results to return (max: 1000000).
before
string
Cursor for backward pagination.
after
string
Cursor for forward pagination.
fields
string
Comma-separated list of fields to include: owners, tags, domains. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/services/dashboardServices
from metadata.sdk import configure
import requests

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List dashboard services
response = requests.get(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices?limit=50",
    headers={"Authorization": "Bearer your-jwt-token"}
)

result = response.json()
for svc in result["data"]:
    print(f"{svc['fullyQualifiedName']} ({svc['serviceType']})")

# With fields
response = requests.get(
    "https://your-company.getcollate.io/api/v1/services/dashboardServices?fields=owners,tags,domains&limit=50",
    headers={"Authorization": "Bearer your-jwt-token"}
)
{
  "data": [
    {
      "id": "2c0c7c05-d820-4bea-a471-047deb7f92fd",
      "name": "sample_looker",
      "fullyQualifiedName": "sample_looker",
      "serviceType": "Looker",
      "version": 0.1,
      "updatedAt": 1769982621219,
      "updatedBy": "admin",
      "href": "http://localhost:8585/api/v1/services/dashboardServices/2c0c7c05-d820-4bea-a471-047deb7f92fd",
      "deleted": false,
      "owners": [],
      "tags": [],
      "domains": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

Returns

Returns a paginated list of dashboard service objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data
array
Array of dashboard service objects.
paging
object
Pagination information.

Supported Fields

The following fields can be requested via the fields query parameter:
FieldDescription
ownersOwner references (users and teams)
tagsClassification tags
domainsDomain assignments for governance

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to list dashboard services