Export Organization Usage
GET /api/v1/organizations/{organizationId}/usage-export.csvCurrent customer capacity use and configured limits as CSV; not a billing history. Requires a provider or matching customer administrator session. Incomplete storage measurement is explicitly unavailable rather than zero. Includes retained recording ownership.
Access
Section titled “Access”Authentication options declared in the contract include user cookie session or bearer service token.
The shared authentication policy requires organizationAccounts:manage. Resource access also depends on the caller’s role, organization, camera grants, and the operation’s validation.
Authentication and permissions explains tokens, cookies, CSRF, and workspace context.
Parameters
Section titled “Parameters”| Name | Location | Required | Type | Description and constraints |
|---|---|---|---|---|
organizationId |
path | Yes | string (uuid) | |
X-EyesOnIt-Session-Id |
header | No | string (uuid) | The sessionId the caller expects. Required when switching workspaces and for cookie requests after workspace rotation. A mismatched value returns 409 with X-EyesOnIt-Workspace-Changed: 1. Bootstrap with getCurrentPrincipal; never replay a mutation automatically after changing context. Bearer clients do not use this header. |
cURL request template
Section titled “cURL request template”Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. This template sends the request when run.
curl --fail-with-body --silent --show-error \ --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \ --dump-header response-headers.txt \ --output response.bin \ "${EOI_API_BASE_URL}/organizations/${EOI_ORGANIZATIONID}/usage-export.csv"Contract responses
Section titled “Contract responses”The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.
| Status | Description | Media type | Body |
|---|---|---|---|
| 200 | Successful Response | text/csv |
string |
| 422 | Validation Error | application/json |
HTTPValidationError |
Operation identifier exportOrganizationUsage. Browse Organizations and workspaces.
