> ## Documentation Index > Fetch the complete documentation index at: https://docs.clustr-ai.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Usage Statement > The monthly statement: one line for each workspace, a total, and your contract limits. Add `format=csv` for a CSV file with one row per `external_id` and a `TOTAL` row. **Scope:** `usage:read`. ## OpenAPI ````yaml /enterprise/openapi.yaml get /usage/statement openapi: 3.1.0 info: title: Clustr Organization API description: > Organization-level operations for partners who run Clustr for many clients: workspaces, the signed webhook, usage and contract limits, erasure and the audit log. This API covers the organization only. Everything a workspace does (imports, jobs, search, saved views, tags) is the public API at `https://api.clustr-ai.com/api/public`, called with the organization key and an `X-Clustr-Tenant` header. ## Authentication Every endpoint needs an organization API key (it starts with `clo_`) in the `Authorization` header. ``` Authorization: Bearer clo_... ``` Clustr staff create organization keys. Each key carries scopes; an operation that needs a scope the key lacks answers `403`. version: '1.0' contact: name: Clustr Support url: https://clustr-ai.com servers: - url: https://api.clustr-ai.com/api/org/v1 description: Production security: - OrgKey: [] tags: - name: Workspaces description: >- Create, read, rename, suspend, resume and delete the workspaces of your organization. - name: Webhook description: The organization's signed webhook, its secret and its deliveries. - name: Usage and limits description: >- What your organization used, the monthly statement, and your contract limits. - name: Erasure description: Remove one person from every workspace of the organization. - name: Audit log description: The organization's own record of every call. paths: /usage/statement: get: tags: - Usage and limits summary: Get Usage Statement description: > The monthly statement: one line for each workspace, a total, and your contract limits. Add `format=csv` for a CSV file with one row per `external_id` and a `TOTAL` row. **Scope:** `usage:read`. operationId: getUsageStatement parameters: - name: month in: query required: false description: The UTC month, as `YYYY-MM`. Default the current month. schema: type: string pattern: ^[0-9]{4}-[0-9]{2}$ example: 2026-10 - name: format in: query required: false description: '`json` (default) or `csv`.' schema: type: string enum: - json - csv default: json responses: '200': description: >- The statement. With `format=csv` it is a file named `usage-.csv` with the columns `external_id`, `tenant_id`, `connectors_processed`, `profiles_fresh`, `profiles_cached` and `export_rows`. content: application/json: schema: $ref: '#/components/schemas/StatementResponse' example: success: true data: organizationId: 5d8e2b1a-0c3f-4e7d-9a6b-1f2e3d4c5b6a month: 2026-10 limits: monthlyConnectorLimit: 50000 maxJobSize: null total: connectorsProcessed: 1840 profilesFresh: 620 profilesCached: 1220 exportRows: 15200 tenants: - tenantId: 3f6c1d2e-8a4b-4c1f-9e2d-7b5a0c9e1f42 externalId: client-1234 connectorsProcessed: 1840 profilesFresh: 620 profilesCached: 1220 exportRows: 15200 text/csv: schema: type: string example: > external_id,tenant_id,connectors_processed,profiles_fresh,profiles_cached,export_rows client-1234,3f6c1d2e-8a4b-4c1f-9e2d-7b5a0c9e1f42,1840,620,1220,640,12.8000,15200 TOTAL,,1840,620,1220,640,12.8000,15200 '400': description: The month or the format is not valid. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' '502': $ref: '#/components/responses/BadGateway' components: schemas: StatementResponse: type: object required: - success - data properties: success: type: boolean example: true data: $ref: '#/components/schemas/Statement' ErrorResponse: type: object description: >- Every error has this shape. Branch on `error.code`; `error.message` is for people. required: - success - error properties: success: type: boolean example: false error: type: object required: - code - message properties: code: type: string description: >- A stable code to branch on, such as `BAD_REQUEST`, `NOT_FOUND` or `CONFLICT`. example: BAD_REQUEST message: type: string description: A sentence a person can read. example: Invalid request body. request_id: type: string description: Quote it to Clustr support. Statement: type: object properties: organizationId: type: string format: uuid month: type: string example: 2026-10 limits: $ref: '#/components/schemas/ContractLimits' total: $ref: '#/components/schemas/UsageTotals' tenants: type: array description: One line per workspace. items: $ref: '#/components/schemas/WorkspaceUsage' ContractLimits: type: object properties: monthlyConnectorLimit: type: - integer - 'null' description: Connectors you may process per UTC month. `null` means no limit. example: 50000 maxJobSize: type: - integer - 'null' description: The largest job. `null` means 1,000. example: null UsageTotals: type: object properties: connectorsProcessed: type: integer format: int64 description: >- Connectors in import jobs that completed. This is the unit of your monthly volume. example: 1840 profilesFresh: type: integer format: int64 description: New profiles delivered. example: 620 profilesCached: type: integer format: int64 description: Profiles delivered that Clustr already knew. example: 1220 exportRows: type: integer format: int64 description: Rows written to your data stores by exports. example: 15200 WorkspaceUsage: allOf: - $ref: '#/components/schemas/UsageTotals' - type: object properties: tenantId: type: string format: uuid externalId: type: string description: >- Your own id for the workspace. Empty when it has none or was deleted. example: client-1234 responses: Unauthorized: description: >- The key is missing, invalid or revoked, or it is not an organization key. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UNAUTHORIZED message: Invalid or revoked API key Forbidden: description: The key lacks the scope this operation needs. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: FORBIDDEN message: This key lacks the tenants:write scope TooManyRequests: description: >- Your organization is over its rate limit. The limit is shared by all keys and workspaces of the organization. Wait for `Retry-After`, then retry. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: RATE_LIMITED message: Too many requests BadGateway: description: The organization service could not be reached. Retry later. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: code: UPSTREAM_UNAVAILABLE message: The organization service is unavailable headers: RetryAfter: description: Seconds to wait before retrying. schema: type: integer RateLimitLimit: description: Requests per second allowed for your organization. schema: type: integer RateLimitRemaining: description: Requests left in the current window. Always `0` on a `429`. schema: type: integer RateLimitReset: description: Unix time (seconds) when requests are allowed again. schema: type: integer securitySchemes: OrgKey: type: http scheme: bearer description: >- Organization API key (`clo_...`). The `X-API-Key` header is also accepted in place of `Authorization: Bearer`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.