---
title: "Allow/block lists"
method: GET
path: "/v1/inboxes/{inboxId}/lists"
tags: ["Inboxes"]
---

# Allow/block lists

`GET /v1/inboxes/{inboxId}/lists`

## Request

- Base URL: `https://api.volanea.com`
- URL: `https://api.volanea.com/v1/inboxes/{inboxId}/lists`
- Auth: HTTP bearer

`receive`: who may write to the inbox. `send`: who it may write to. Block wins; a non-empty allow list admits only what it names.

## Path parameters

- `inboxId` string, required

## Response `200`

Entries.

- object
  - `data` InboxListEntry[], required
    - `entryId` string, required
    - `direction` 'receive' | 'send', required
    - `type` 'allow' | 'block', required
    - `entry` string, required: An address, or a domain (matches its subdomains too).
    - `createdAt` string, date-time
  - `nextCursor` string, nullable, required: Opaque token. Pass back as `cursor` verbatim to fetch the next page; `null` when there are no more rows.

## Other responses

- `401`: Missing or invalid API key.
- `404`: Not found.
- `422`: Request validation failed (code `validation_error`, 422).

---

[API](https://skmtc.dev/volanea/apis/volanea-api.md) · [All operations](https://skmtc.dev/volanea/apis/volanea-api/llms.txt) · [OpenAPI document](https://skmtc.dev/volanea/apis/volanea-api/revisions/9e187ae84fda?raw)
