---
title: Inboxes
---

## List Inboxes
**Endpoint**: `GET /agent/v0/inboxes`
**Authentication**: `Authorization: Bearer <token>`
### Parameters

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `ascending` | query | boolean | No |  |
| `limit` | query | integer | No |  |
| `page_token` | query | string | No |  |

### Responses

#### `200`

Response with status 200

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `count` | integer | Yes | Number of items returned. |
| `inboxes` | array\<object\> | Yes | Ordered by `created_at` descending. |
| `limit` | integer | No | Limit of number of items returned. |
| `next_page_token` | string | No | Page token for pagination. |

##### Example

```json
{
  "count": 0,
  "inboxes": [
    {
      "client_id": "<string>",
      "created_at": "2026-01-01T00:00:00Z",
      "display_name": "<string>",
      "email": "<string>",
      "inbox_id": "<string>",
      "pod_id": "<string>",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ],
  "limit": 0,
  "next_page_token": "<string>"
}
```


## Create Inbox
**Endpoint**: `POST /agent/v0/inboxes`
**Authentication**: `Authorization: Bearer <token>`
### Request Body
Content-Type: `application/json`
#### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `client_id` | string | No | Client ID of inbox. |
| `display_name` | string | No | Display name: `Display Name \<username@domain.com\>`. |
| `domain` | string | No | Domain of address. Must be verified domain. Defaults to `agentry.to`. |
| `username` | string | No | Username of address. Randomly generated if not specified. |

#### Example

```json
{
  "client_id": "<string>",
  "display_name": "<string>",
  "domain": "<string>",
  "username": "<string>"
}
```

### Responses

#### `200`

Response with status 200

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `client_id` | string | No | Client ID of inbox. |
| `created_at` | string | Yes | Time at which inbox was created. |
| `display_name` | string | No | Display name: `Display Name \<username@domain.com\>`. |
| `email` | string | Yes | Email address of the inbox. |
| `inbox_id` | string | Yes | The ID of the inbox. |
| `pod_id` | string | Yes | ID of pod. |
| `updated_at` | string | Yes | Time at which inbox was last updated. |

##### Example

```json
{
  "client_id": "<string>",
  "created_at": "2026-01-01T00:00:00Z",
  "display_name": "<string>",
  "email": "<string>",
  "inbox_id": "<string>",
  "pod_id": "<string>",
  "updated_at": "2026-01-01T00:00:00Z"
}
```

#### `400`

Error response with status 400

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `errors` | object | Yes | Validation errors. |
| `name` | string | Yes | Name of error. |

##### Example

```json
{
  "errors": null,
  "name": "<string>"
}
```


## Get Inbox
**Endpoint**: `GET /agent/v0/inboxes/{inbox_id}`
**Authentication**: `Authorization: Bearer <token>`
### Parameters

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `inbox_id` | path | string | Yes |  |

### Responses

#### `200`

Response with status 200

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `client_id` | string | No | Client ID of inbox. |
| `created_at` | string | Yes | Time at which inbox was created. |
| `display_name` | string | No | Display name: `Display Name \<username@domain.com\>`. |
| `email` | string | Yes | Email address of the inbox. |
| `inbox_id` | string | Yes | The ID of the inbox. |
| `pod_id` | string | Yes | ID of pod. |
| `updated_at` | string | Yes | Time at which inbox was last updated. |

##### Example

```json
{
  "client_id": "<string>",
  "created_at": "2026-01-01T00:00:00Z",
  "display_name": "<string>",
  "email": "<string>",
  "inbox_id": "<string>",
  "pod_id": "<string>",
  "updated_at": "2026-01-01T00:00:00Z"
}
```

#### `404`

Error response with status 404

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `message` | string | Yes | Error message. |
| `name` | string | Yes | Name of error. |

##### Example

```json
{
  "message": "<string>",
  "name": "<string>"
}
```


## Update Inbox
**Endpoint**: `PATCH /agent/v0/inboxes/{inbox_id}`
**Authentication**: `Authorization: Bearer <token>`
### Parameters

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `inbox_id` | path | string | Yes |  |

### Request Body
Content-Type: `application/json`
#### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `display_name` | string | Yes | Display name: `Display Name \<username@domain.com\>`. |

#### Example

```json
{
  "display_name": "<string>"
}
```

### Responses

#### `200`

Response with status 200

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `client_id` | string | No | Client ID of inbox. |
| `created_at` | string | Yes | Time at which inbox was created. |
| `display_name` | string | No | Display name: `Display Name \<username@domain.com\>`. |
| `email` | string | Yes | Email address of the inbox. |
| `inbox_id` | string | Yes | The ID of the inbox. |
| `pod_id` | string | Yes | ID of pod. |
| `updated_at` | string | Yes | Time at which inbox was last updated. |

##### Example

```json
{
  "client_id": "<string>",
  "created_at": "2026-01-01T00:00:00Z",
  "display_name": "<string>",
  "email": "<string>",
  "inbox_id": "<string>",
  "pod_id": "<string>",
  "updated_at": "2026-01-01T00:00:00Z"
}
```

#### `404`

Error response with status 404

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `message` | string | Yes | Error message. |
| `name` | string | Yes | Name of error. |

##### Example

```json
{
  "message": "<string>",
  "name": "<string>"
}
```


## Delete Inbox
**Endpoint**: `DELETE /agent/v0/inboxes/{inbox_id}`
**Authentication**: `Authorization: Bearer <token>`
### Parameters

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `inbox_id` | path | string | Yes |  |

### Responses

#### `200`

Successful response

#### `404`

Error response with status 404

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `message` | string | Yes | Error message. |
| `name` | string | Yes | Name of error. |

##### Example

```json
{
  "message": "<string>",
  "name": "<string>"
}
```