# List events

Source: https://jointextkit.com/docs/api/events/list
Index: https://jointextkit.com/llms.txt

`GET /v1/events`

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Default 25. Maximum 100. |
| `cursor` | string | No |  |
| `type` | string | No | Example: `message.delivered`. |

Results are paged. When `has_more` is true, pass `next_cursor` from the response as `cursor` to fetch the next page.

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Events, newest first | Page of `Event` |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: each item in `data` (Event)

The body is a page: `data` (the array), `has_more`, and `next_cursor` (null on the last page).

| Field | Type | Description |
| --- | --- | --- |
| `id` | string | Example: `evt_a1B2c3D4e5F6g7H8`. |
| `object` | `event` |  |
| `type` | `message.sent`, `message.delivered`, `message.failed`, `message.received`, `message.opted_out`, `message.opted_in`, `message.help_requested`, `message.blocked`, `message.deferred`, `message.link_clicked`, `broadcast.complete`, `number.purchased`, `number.released`, `number.sender_updated`, `verification.sent`, `verification.approved`, `verification.failed`, `verification.blocked`, `verification.sent_to_opted_out`, `registration.updated`, `deliverability.degraded`, `compliance.flagged`, `compliance.paused`, `compliance.resumed`, `spend.threshold_reached`, `credits.low`, `credits.depleted`, `credits.topped_up`, `credits.auto_recharge_failed`, `automation.run.started`, `automation.run.completed`, `automation.run.failed`, `schedule.occurrence_skipped`, `schedule.paused`, `batch.created`, `batch.paused`, `batch.resumed`, `batch.canceled`, `batch.retried`, `batch.complete` |  |
| `mode` | `test`, `live` | Sandbox or live traffic. A key sees only its own mode's events, and an endpoint receives only its own mode's. |
| `created_at` | string (date-time) |  |
| `data` | object | The subject of the event. Events about one message (message.sent, .delivered, .failed, .received, .blocked) include `message_id`, its `price` (the same object GET /v1/messages/{id} shows) and its `tags` when it has any. |

## Errors

| Status | When |
| --- | --- |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Examples

### Node.js

```javascript
import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

const events = await sms.events.list({ limit: 10 });

for (const event of events.data) console.log(event.type, event.id);
```

### PHP

```php
<?php

$ch = curl_init('https://api.jointextkit.com/v1/events?limit=10');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'),
    ],
]);

$data = json_decode(curl_exec($ch), true);
```

### Python

```python
import os
from jointextkit import TextKit  # pip install jointextkit

client = TextKit(os.environ["TEXTKIT_API_KEY"])

events = client.events.list(limit=10)

for event in events["data"]:
    print(event["type"], event["id"])
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://api.jointextkit.com/v1/events?limit=10")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}"

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
```

### Go

```go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.jointextkit.com/v1/events?limit=10", nil)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(data))
}
```

### Rust

```rust
// cargo add reqwest --features blocking,json
// cargo add serde_json

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let key = std::env::var("TEXTKIT_API_KEY")?;
    let res = reqwest::blocking::Client::new()
        .get("https://api.jointextkit.com/v1/events?limit=10")
        .bearer_auth(key)
        .send()?
        .error_for_status()?;
    let data: serde_json::Value = res.json()?;
    println!("{data}");
    Ok(())
}
```

### Java

```java
import java.net.URI;
import java.net.http.*;

public class Main {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder(URI.create("https://api.jointextkit.com/v1/events?limit=10"))
            .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY"))
            .GET()
            .build();

        var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
```

### .NET

```csharp
using System.Net.Http.Headers;

var http = new HttpClient();
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("TEXTKIT_API_KEY"));

var res = await http.GetAsync("https://api.jointextkit.com/v1/events?limit=10");
res.EnsureSuccessStatusCode();

var data = await res.Content.ReadAsStringAsync();
```

### cURL

```bash
curl -X GET "https://api.jointextkit.com/v1/events?limit=10" \
  -H "Authorization: Bearer $TEXTKIT_API_KEY"
```

## Related

- Guide: [Webhooks](/docs/webhooks)
- [All events endpoints](/docs/api#events)
- [API reference](/docs/api)