Get report by handle

Returns one report definition, including edit/delete permissions for the current user.

GET/api/reports/{handle}

Returns one report definition, including edit/delete permissions for the current user.

Path Parameters

handle*string

Stable handle used in routes and lookups.

Example"sales"

Response Body

`application/json`

curl -X GET "https://loading/api/reports/sales"

{
  "id": "report_123",
  "handle": "sales",
  "name": "Sales Overview",
  "description": "Quotes by customer, product, and owner",
  "visibility": "private",
  "ownerId": "workspace_user_123",
  "ownerName": "Ana Torres",
  "createdAt": "2026-03-20T12:00:00.000Z",
  "updatedAt": "2026-03-20T12:10:00.000Z",
  "isBuiltIn": false,
  "canEdit": true,
  "canDelete": true,
  "data": null
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Get report by handle

Path Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`