---
title: Lists
---

## List Entries
**Endpoint**: `GET /agent/v0/pods/{pod_id}/lists/{direction}/{type}`
**Authentication**: `Authorization: Bearer <token>`
### Parameters

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `direction` | path | `send` \| `receive` \| `reply` | Yes |  |
| `pod_id` | path | string | Yes |  |
| `type` | path | `allow` \| `block` | Yes |  |
| `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. |
| `entries` | array\<object\> | Yes | Ordered by entry ascending. |
| `limit` | integer | No | Limit of number of items returned. |
| `next_page_token` | string | No | Page token for pagination. |

##### Example

```json
{
  "count": 0,
  "entries": [
    {
      "created_at": "2026-01-01T00:00:00Z",
      "direction": "send",
      "entry": "<string>",
      "entry_type": "email",
      "inbox_id": "<string>",
      "list_type": "allow",
      "organization_id": "<string>",
      "pod_id": "<string>",
      "reason": "<string>"
    }
  ],
  "limit": 0,
  "next_page_token": "<string>"
}
```


## Create List Entry
**Endpoint**: `POST /agent/v0/pods/{pod_id}/lists/{direction}/{type}`
**Authentication**: `Authorization: Bearer <token>`
### Parameters

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `direction` | path | `send` \| `receive` \| `reply` | Yes |  |
| `pod_id` | path | string | Yes |  |
| `type` | path | `allow` \| `block` | Yes |  |

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

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `entry` | string | Yes | Email address or domain to add. |
| `reason` | string | No | Reason for adding the entry. |

#### Example

```json
{
  "entry": "<string>",
  "reason": "<string>"
}
```

### Responses

#### `200`

Response with status 200

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `created_at` | string | Yes | Time at which entry was created. |
| `direction` | `send` \| `receive` \| `reply` | Yes | Direction of list entry. |
| `entry` | string | Yes | Email address or domain of list entry. |
| `entry_type` | `email` \| `domain` | Yes | Whether the entry is an email address or domain. |
| `inbox_id` | string | No | ID of inbox, if entry is inbox-scoped. |
| `list_type` | `allow` \| `block` | Yes | Type of list entry. |
| `organization_id` | string | Yes | ID of organization. |
| `pod_id` | string | Yes | ID of pod. |
| `reason` | string | No | Reason for adding the entry. |

##### Example

```json
{
  "created_at": "2026-01-01T00:00:00Z",
  "direction": "send",
  "entry": "<string>",
  "entry_type": "email",
  "inbox_id": "<string>",
  "list_type": "allow",
  "organization_id": "<string>",
  "pod_id": "<string>",
  "reason": "<string>"
}
```

#### `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 List Entry
**Endpoint**: `GET /agent/v0/pods/{pod_id}/lists/{direction}/{type}/{entry}`
**Authentication**: `Authorization: Bearer <token>`
### Parameters

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `direction` | path | `send` \| `receive` \| `reply` | Yes |  |
| `entry` | path | string | Yes | Email address or domain. |
| `pod_id` | path | string | Yes |  |
| `type` | path | `allow` \| `block` | Yes |  |

### Responses

#### `200`

Response with status 200

Content-Type: `application/json`

##### Fields

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `created_at` | string | Yes | Time at which entry was created. |
| `direction` | `send` \| `receive` \| `reply` | Yes | Direction of list entry. |
| `entry` | string | Yes | Email address or domain of list entry. |
| `entry_type` | `email` \| `domain` | Yes | Whether the entry is an email address or domain. |
| `inbox_id` | string | No | ID of inbox, if entry is inbox-scoped. |
| `list_type` | `allow` \| `block` | Yes | Type of list entry. |
| `organization_id` | string | Yes | ID of organization. |
| `pod_id` | string | Yes | ID of pod. |
| `reason` | string | No | Reason for adding the entry. |

##### Example

```json
{
  "created_at": "2026-01-01T00:00:00Z",
  "direction": "send",
  "entry": "<string>",
  "entry_type": "email",
  "inbox_id": "<string>",
  "list_type": "allow",
  "organization_id": "<string>",
  "pod_id": "<string>",
  "reason": "<string>"
}
```

#### `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 List Entry
**Endpoint**: `DELETE /agent/v0/pods/{pod_id}/lists/{direction}/{type}/{entry}`
**Authentication**: `Authorization: Bearer <token>`
### Parameters

| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `direction` | path | `send` \| `receive` \| `reply` | Yes |  |
| `entry` | path | string | Yes | Email address or domain. |
| `pod_id` | path | string | Yes |  |
| `type` | path | `allow` \| `block` | 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>"
}
```