---
updatedAt: 2026-09-02T17:35:26.000Z
agentTools:
  projectIndex: https://docs.go.v7labs.com/llms.txt
---

# List token usage reports

Lists all token usage reports in the workspace with pagination.
Returns metadata only (no report data).


# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "Common.APIErrorDetails": {
        "description": "Additional structured error context. Shape varies by error code.\n\n- For conflict errors: contains a `conflicts` array with conflicting resources\n- For other errors: may contain arbitrary error-specific context",
        "nullable": true,
        "oneOf": [
          {
            "$ref": "#/components/schemas/Common.ConflictErrorDetails"
          },
          {
            "additionalProperties": true,
            "description": "Generic error details for non-conflict errors",
            "type": "object"
          }
        ],
        "title": "Common.APIErrorDetails"
      },
      "Pagination.Cursor": {
        "description": "A base64 encoded value representing a cursor, or an element ID if applicable",
        "example": "ZXhhbXBsZQo=",
        "nullable": true,
        "title": "Pagination.Cursor",
        "type": "string"
      },
      "Pagination.OrderDirections": {
        "description": "List of order directions for the fields in `order_by`. The `*_nulls_last` / `*_nulls_first` variants control where empty values are placed.",
        "example": [
          "desc_nulls_last",
          "asc"
        ],
        "items": {
          "enum": [
            "asc",
            "desc",
            "asc_nulls_last",
            "asc_nulls_first",
            "desc_nulls_last",
            "desc_nulls_first"
          ],
          "type": "string"
        },
        "nullable": true,
        "title": "Pagination.OrderDirections",
        "type": "array"
      },
      "TokenReports.ChatReportFilters": {
        "additionalProperties": false,
        "description": "Filters for chat reports",
        "properties": {
          "case_ids": {
            "description": "Filter to specific cases",
            "items": {
              "$ref": "#/components/schemas/Common.UUID"
            },
            "type": "array"
          },
          "user_ids": {
            "description": "Filter to specific users",
            "items": {
              "$ref": "#/components/schemas/Common.UUID"
            },
            "type": "array"
          }
        },
        "title": "TokenReports.ChatReportFilters",
        "type": "object"
      },
      "Common.ConflictErrorDetails": {
        "additionalProperties": false,
        "description": "Details for conflict errors",
        "properties": {
          "conflicts": {
            "description": "List of conflicting resources",
            "items": {
              "additionalProperties": true,
              "type": "object"
            },
            "type": "array"
          }
        },
        "required": [
          "conflicts"
        ],
        "title": "Common.ConflictErrorDetails",
        "type": "object"
      },
      "TokenReports.Granularity": {
        "description": "Time granularity for aggregation.\n- `hourly`: Max 3 days date range\n- `daily`: Max 1 month date range\n- `weekly`: Max 3 months date range\n- `monthly`: Max 6 months date range\n\nWorkspaces with extended report ranges enabled accept up to 180 days\nfor daily and weekly granularities, and up to 1 year for monthly.\n",
        "enum": [
          "hourly",
          "daily",
          "weekly",
          "monthly"
        ],
        "title": "TokenReports.Granularity",
        "type": "string"
      },
      "TokenReports.ReportListItem": {
        "description": "Token report list item (structure varies by status)",
        "oneOf": [
          {
            "$ref": "#/components/schemas/TokenReports.PendingReportListItem"
          },
          {
            "$ref": "#/components/schemas/TokenReports.ProcessingReportListItem"
          },
          {
            "$ref": "#/components/schemas/TokenReports.CompletedReportListItem"
          },
          {
            "$ref": "#/components/schemas/TokenReports.FailedReportListItem"
          }
        ],
        "title": "TokenReports.ReportListItem"
      },
      "Pagination.PageSize": {
        "description": "The page size or limit of the query. Set to the `first` or `last` parameter when using cursor-based pagination.",
        "example": 50,
        "minimum": 1,
        "title": "Pagination.PageSize",
        "type": "integer"
      },
      "Common.UUID": {
        "example": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
        "format": "uuid",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
        "title": "Common.UUID",
        "type": "string"
      },
      "TokenReports.FailedReportListItem": {
        "additionalProperties": false,
        "description": "Failed report list item",
        "properties": {
          "created_at": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "created_by_id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "error_message": {
            "description": "Error message describing the failure",
            "type": "string"
          },
          "filters": {
            "$ref": "#/components/schemas/TokenReports.ReportFilters"
          },
          "from": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "granularity": {
            "$ref": "#/components/schemas/TokenReports.Granularity"
          },
          "group_by": {
            "items": {
              "$ref": "#/components/schemas/TokenReports.GroupByDimension"
            },
            "type": "array"
          },
          "id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "report_type": {
            "$ref": "#/components/schemas/TokenReports.ReportType"
          },
          "status": {
            "enum": [
              "failed"
            ],
            "type": "string"
          },
          "to": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "workspace_id": {
            "$ref": "#/components/schemas/Common.UUID"
          }
        },
        "required": [
          "id",
          "workspace_id",
          "report_type",
          "status",
          "granularity",
          "from",
          "to",
          "group_by",
          "created_at",
          "created_by_id",
          "error_message"
        ],
        "title": "TokenReports.FailedReportListItem",
        "type": "object"
      },
      "TokenReports.ReportFilters": {
        "anyOf": [
          {
            "$ref": "#/components/schemas/TokenReports.AgentReportFilters"
          },
          {
            "$ref": "#/components/schemas/TokenReports.ChatReportFilters"
          },
          {
            "$ref": "#/components/schemas/TokenReports.PlaybookReportFilters"
          }
        ],
        "description": "Report filters (varies by report_type)",
        "title": "TokenReports.ReportFilters"
      },
      "Pagination.PageMetadata": {
        "additionalProperties": false,
        "description": "Metadata returns for paginated requests. The values set depend on the type of pagination used",
        "properties": {
          "current_offset": {
            "$ref": "#/components/schemas/Pagination.Offset"
          },
          "end_cursor": {
            "$ref": "#/components/schemas/Pagination.Cursor"
          },
          "has_next_page": {
            "example": true,
            "type": "boolean"
          },
          "has_previous_page": {
            "example": false,
            "type": "boolean"
          },
          "page_size": {
            "$ref": "#/components/schemas/Pagination.PageSize"
          },
          "start_cursor": {
            "$ref": "#/components/schemas/Pagination.Cursor"
          },
          "total_count": {
            "$ref": "#/components/schemas/Pagination.TotalCount"
          }
        },
        "required": [
          "current_offset",
          "page_size",
          "start_cursor",
          "end_cursor",
          "has_next_page",
          "has_previous_page",
          "total_count"
        ],
        "title": "Pagination.PageMetadata",
        "type": "object"
      },
      "TokenReports.PlaybookReportFilters": {
        "additionalProperties": false,
        "description": "Filters for playbook reports",
        "properties": {
          "playbook_ids": {
            "description": "Filter to specific playbooks",
            "items": {
              "$ref": "#/components/schemas/Common.UUID"
            },
            "type": "array"
          }
        },
        "title": "TokenReports.PlaybookReportFilters",
        "type": "object"
      },
      "Pagination.TotalCount": {
        "description": "The total count of records for the given query. Always `null` when using cursor-based  pagination.",
        "example": 50,
        "nullable": true,
        "title": "Pagination.TotalCount",
        "type": "integer"
      },
      "TokenReports.GroupByDimension": {
        "description": "Grouping dimension. Available options vary by report type:\n- agent: `model`, `property`\n- hub: `model`\n- chat: `case`, `user`, `model`\n- playbook: `model`, `playbook_run`\n- summary: `model`\n- user_usage: no grouping dimensions\n",
        "enum": [
          "model",
          "case",
          "user",
          "property",
          "playbook_run"
        ],
        "title": "TokenReports.GroupByDimension",
        "type": "string"
      },
      "Pagination.Offset": {
        "description": "The offset to use when paginating records",
        "example": 50,
        "minimum": 0,
        "nullable": true,
        "title": "Pagination.Offset",
        "type": "integer"
      },
      "TokenReports.ListReportsResponse": {
        "additionalProperties": false,
        "description": "Paginated list of token reports",
        "properties": {
          "data": {
            "items": {
              "$ref": "#/components/schemas/TokenReports.ReportListItem"
            },
            "type": "array"
          },
          "meta": {
            "$ref": "#/components/schemas/Pagination.PageMetadata"
          }
        },
        "required": [
          "data",
          "meta"
        ],
        "title": "TokenReports.ListReportsResponse",
        "type": "object"
      },
      "TokenReports.CompletedReportListItem": {
        "additionalProperties": false,
        "description": "Completed report list item",
        "properties": {
          "completed_at": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "created_at": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "created_by_id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "filters": {
            "$ref": "#/components/schemas/TokenReports.ReportFilters"
          },
          "from": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "granularity": {
            "$ref": "#/components/schemas/TokenReports.Granularity"
          },
          "group_by": {
            "items": {
              "$ref": "#/components/schemas/TokenReports.GroupByDimension"
            },
            "type": "array"
          },
          "id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "report_type": {
            "$ref": "#/components/schemas/TokenReports.ReportType"
          },
          "row_count": {
            "description": "Number of rows in the report",
            "type": "integer"
          },
          "status": {
            "enum": [
              "completed"
            ],
            "type": "string"
          },
          "to": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "workspace_id": {
            "$ref": "#/components/schemas/Common.UUID"
          }
        },
        "required": [
          "id",
          "workspace_id",
          "report_type",
          "status",
          "granularity",
          "from",
          "to",
          "group_by",
          "created_at",
          "created_by_id",
          "row_count",
          "completed_at"
        ],
        "title": "TokenReports.CompletedReportListItem",
        "type": "object"
      },
      "TokenReports.ListReportsOrderBy": {
        "description": "List of field names to order by",
        "example": [
          "created_at"
        ],
        "items": {
          "enum": [
            "created_at"
          ],
          "type": "string"
        },
        "nullable": true,
        "title": "TokenReports.ListReportsOrderBy",
        "type": "array"
      },
      "Pagination.Last": {
        "description": "The number of records to return for before the provided cursor; used in combination with `before`",
        "example": 50,
        "nullable": true,
        "title": "Pagination.Last",
        "type": "integer"
      },
      "TokenReports.ReportType": {
        "description": "Type of token usage report",
        "enum": [
          "agent",
          "hub",
          "chat",
          "playbook",
          "summary",
          "user_usage",
          "knowledge_graph"
        ],
        "title": "TokenReports.ReportType",
        "type": "string"
      },
      "TokenReports.ReportStatus": {
        "description": "Current status of the report",
        "enum": [
          "pending",
          "processing",
          "completed",
          "failed"
        ],
        "title": "TokenReports.ReportStatus",
        "type": "string"
      },
      "Common.DateTime": {
        "description": "DateTime in RFC3339 format",
        "example": "2020-01-20T14:00:00Z",
        "format": "date-time",
        "title": "Common.DateTime",
        "type": "string"
      },
      "Pagination.First": {
        "description": "The number of records to return after the provided cursor; used in combination with `after`",
        "example": 50,
        "nullable": true,
        "title": "Pagination.First",
        "type": "integer"
      },
      "TokenReports.ProcessingReportListItem": {
        "additionalProperties": false,
        "description": "Processing report list item",
        "properties": {
          "created_at": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "created_by_id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "filters": {
            "$ref": "#/components/schemas/TokenReports.ReportFilters"
          },
          "from": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "granularity": {
            "$ref": "#/components/schemas/TokenReports.Granularity"
          },
          "group_by": {
            "items": {
              "$ref": "#/components/schemas/TokenReports.GroupByDimension"
            },
            "type": "array"
          },
          "id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "report_type": {
            "$ref": "#/components/schemas/TokenReports.ReportType"
          },
          "status": {
            "enum": [
              "processing"
            ],
            "type": "string"
          },
          "to": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "workspace_id": {
            "$ref": "#/components/schemas/Common.UUID"
          }
        },
        "required": [
          "id",
          "workspace_id",
          "report_type",
          "status",
          "granularity",
          "from",
          "to",
          "group_by",
          "created_at",
          "created_by_id"
        ],
        "title": "TokenReports.ProcessingReportListItem",
        "type": "object"
      },
      "Common.APIError": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "example": "bad_request",
            "type": "string"
          },
          "details": {
            "$ref": "#/components/schemas/Common.APIErrorDetails"
          },
          "message": {
            "example": "Bad Request",
            "type": "string"
          }
        },
        "required": [
          "code",
          "message"
        ],
        "title": "Common.APIError",
        "type": "object"
      },
      "TokenReports.PendingReportListItem": {
        "additionalProperties": false,
        "description": "Pending report list item",
        "properties": {
          "created_at": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "created_by_id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "filters": {
            "$ref": "#/components/schemas/TokenReports.ReportFilters"
          },
          "from": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "granularity": {
            "$ref": "#/components/schemas/TokenReports.Granularity"
          },
          "group_by": {
            "items": {
              "$ref": "#/components/schemas/TokenReports.GroupByDimension"
            },
            "type": "array"
          },
          "id": {
            "$ref": "#/components/schemas/Common.UUID"
          },
          "report_type": {
            "$ref": "#/components/schemas/TokenReports.ReportType"
          },
          "status": {
            "enum": [
              "pending"
            ],
            "type": "string"
          },
          "to": {
            "$ref": "#/components/schemas/Common.DateTime"
          },
          "workspace_id": {
            "$ref": "#/components/schemas/Common.UUID"
          }
        },
        "required": [
          "id",
          "workspace_id",
          "report_type",
          "status",
          "granularity",
          "from",
          "to",
          "group_by",
          "created_at",
          "created_by_id"
        ],
        "title": "TokenReports.PendingReportListItem",
        "type": "object"
      },
      "Pagination.Limit": {
        "description": "The maximum number of records to return when using `offset` pagination",
        "example": 50,
        "minimum": 0,
        "nullable": true,
        "title": "Pagination.Limit",
        "type": "integer"
      },
      "TokenReports.AgentReportFilters": {
        "additionalProperties": false,
        "description": "Filters for agent reports",
        "properties": {
          "project_ids": {
            "description": "Filter to specific root projects",
            "items": {
              "$ref": "#/components/schemas/Common.UUID"
            },
            "type": "array"
          }
        },
        "title": "TokenReports.AgentReportFilters",
        "type": "object"
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      },
      "BearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "title": "V7 Go API",
    "version": "0.1.0"
  },
  "openapi": "3.0.0",
  "paths": {
    "/api/workspaces/{workspace_id}/reports/token_reports": {
      "get": {
        "callbacks": {},
        "description": "Lists all token usage reports in the workspace with pagination.\nReturns metadata only (no report data).\n",
        "operationId": "token-reports-list",
        "parameters": [
          {
            "description": "",
            "in": "path",
            "name": "workspace_id",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Common.UUID"
            }
          },
          {
            "description": "Current status of the report",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/TokenReports.ReportStatus"
            }
          },
          {
            "description": "Type of token usage report",
            "in": "query",
            "name": "report_type",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/TokenReports.ReportType"
            }
          },
          {
            "description": "List of field names to order by",
            "in": "query",
            "name": "order_by",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/TokenReports.ListReportsOrderBy"
            }
          },
          {
            "description": "List of order directions for the fields in `order_by`. The `*_nulls_last` / `*_nulls_first` variants control where empty values are placed.",
            "in": "query",
            "name": "order_directions",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Pagination.OrderDirections"
            }
          },
          {
            "description": "The maximum number of records to return when using `offset` pagination",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Pagination.Limit"
            }
          },
          {
            "description": "The offset to use when paginating records",
            "in": "query",
            "name": "offset",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Pagination.Offset"
            }
          },
          {
            "description": "The number of records to return after the provided cursor; used in combination with `after`",
            "in": "query",
            "name": "first",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Pagination.First"
            }
          },
          {
            "description": "The number of records to return for before the provided cursor; used in combination with `before`",
            "in": "query",
            "name": "last",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Pagination.Last"
            }
          },
          {
            "description": "A base64 encoded value representing a cursor, or an element ID if applicable",
            "in": "query",
            "name": "after",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Pagination.Cursor"
            }
          },
          {
            "description": "A base64 encoded value representing a cursor, or an element ID if applicable",
            "in": "query",
            "name": "before",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/Pagination.Cursor"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TokenReports.ListReportsResponse"
                }
              }
            },
            "description": "TokenReports.ListReportsResponse"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "401": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "403": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "404": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "409": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "422": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          },
          "500": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Common.APIError"
                }
              }
            },
            "description": "Common.APIError"
          }
        },
        "summary": "List token usage reports",
        "tags": [
          "Token Reports"
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    },
    {
      "ApiKeyAuth": []
    }
  ],
  "servers": [
    {
      "description": "EU",
      "url": "https://go.v7labs.com",
      "variables": {}
    },
    {
      "description": "US",
      "url": "https://go.us.v7labs.com",
      "variables": {}
    },
    {
      "description": "UAE",
      "url": "https://go.uae.v7labs.com",
      "variables": {}
    }
  ]
}
```