# Get Usage

**GET /v1/usage/**




## Servers
- Production server (uses live data): https://api.aymara.ai (Production server (uses live data))
- Staging server (uses test data): https://staging-api.aymara.ai (Staging server (uses test data))


## Authentication methods
- Api key
- Auth bearer


## Parameters


### Query parameters
- **workspace_uuid** (string | null)



## Responses
### 200
OK

#### Body: application/json (object)
- **billing_cycles** (array[object] | null)

- **free_score_runs** (array[object] | null)

- **test_type_displays** (object)


### 400
Bad Request

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 401
Unauthorized

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 403
Forbidden

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 404
Not Found

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 409
Conflict

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 422
Unprocessable Entity

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 429
Too Many Requests

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 500
Internal Server Error

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)


### 503
Service Unavailable

#### Body: application/json (object)
- **error** (object)
  Schema for the contents of an error response.

  This schema defines the structure of the error data inside the `error` field
  of an API error response.
- **request_id** (string)



[Powered by Bump.sh](https://bump.sh)