> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getedulead.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getedulead.com/_mcp/server.

# ListUsage

GET https://api.getedulead.com/v4/usage

ListUsage pages through the team's usage per counted limit and period, newest period first:
 contacts revealed per month or billing year, emails re-validated per month. A period with no
 usage recorded is not listed; the current period's usage is also on ListLimits.

Reference: https://docs.getedulead.com/api-reference/usage/list

## Authentication

- `Authorization` header (bearer token, required) — A team API key, sent as `Authorization: Bearer <key>`.
- `Authorization` header (bearer token, required) — The Cognito access token of a signed-in Edulead user (`edulead auth login`), sent as `Authorization: Bearer <token>`.

## Request

### Query parameters

- `filter.limit_id` (enum, optional) — Only this limit's periods.
  - Allowed values: `NR_CONTACTS_RETURNED__MONTHLY`, `NR_CONTACTS_RETURNED__ANNUAL`, `NR_EMAIL_VERIFICATIONS__MONTHLY`
- `filter.start_time_min` (datetime, optional) — Only periods that started at or after this time.
- `filter.start_time_max` (datetime, optional) — Only periods that started at or before this time.
- `page_size` (integer, optional) — Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
- `page_token` (string, optional) — Opaque token from a previous response; empty for the first page.
- `order_by` (enum, optional) — Sort order: a sortable field name, optionally followed by " desc". The allowed values are listed.
  - Allowed values: ``, `start_time desc`

## Response

### 200

Success

- `items` (list of edulead.v4.Usage, optional) — The page of results, in the requested order.
- `next_page_token` (string, optional) — Token for the next page; empty when this is the last page.

## Types

### edulead.v4.Usage

Usage is how much the team used of one counted limit in one period. Its id is the limit and the period, such as NR_CONTACTS_RETURNED__MONTHLY/2026-10 or NR_CONTACTS_RETURNED__ANNUAL/2025.

- `id` (string, optional) — Identifier of the resource, assigned by Edulead and opaque to callers.
- `limit_id` (string, optional) — The limit counted, as Limit.id.
- `start_time` (datetime, optional) — When the period started: the first of a month, UTC, or the team's billing anniversary.
- `end_time` (datetime, optional) — When the period ended, or ends: the next period's start.
- `used` (string, optional) — Contacts revealed, or emails re-validated, in the period.

## Examples

**Response**

```json
{
  "items": [
    {
      "id": "string",
      "limit_id": "string",
      "start_time": "2023-01-15T01:30:15.01Z",
      "end_time": "2023-01-15T01:30:15.01Z",
      "used": "string"
    }
  ],
  "next_page_token": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.getedulead.com/v4/usage"

querystring = {"filter.start_time_max":"2023-01-15T01:30:15.01Z","filter.start_time_min":"2023-01-15T01:30:15.01Z"}

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.getedulead.com/v4/usage?filter.start_time_max=2023-01-15T01%3A30%3A15.01Z&filter.start_time_min=2023-01-15T01%3A30%3A15.01Z';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getedulead.com/v4/usage?filter.start_time_max=2023-01-15T01%3A30%3A15.01Z&filter.start_time_min=2023-01-15T01%3A30%3A15.01Z"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.getedulead.com/v4/usage?filter.start_time_max=2023-01-15T01%3A30%3A15.01Z&filter.start_time_min=2023-01-15T01%3A30%3A15.01Z")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.getedulead.com/v4/usage?filter.start_time_max=2023-01-15T01%3A30%3A15.01Z&filter.start_time_min=2023-01-15T01%3A30%3A15.01Z")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.getedulead.com/v4/usage?filter.start_time_max=2023-01-15T01%3A30%3A15.01Z&filter.start_time_min=2023-01-15T01%3A30%3A15.01Z', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.getedulead.com/v4/usage?filter.start_time_max=2023-01-15T01%3A30%3A15.01Z&filter.start_time_min=2023-01-15T01%3A30%3A15.01Z");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.getedulead.com/v4/usage?filter.start_time_max=2023-01-15T01%3A30%3A15.01Z&filter.start_time_min=2023-01-15T01%3A30%3A15.01Z")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```