---
title: "List Lockbox Recipients"
method: GET
path: "/lockbox_recipients"
---

# List Lockbox Recipients

`GET /lockbox_recipients`

## Query parameters

- `cursor` string — Return the page of entries after this one.
- `limit` integer — Limit the size of the list that is returned. The default (and maximum) is 100 objects.
- `account_id` string — Filter Lockbox Recipients to those associated with the provided Account.
- `lockbox_address_id` string — Filter Lockbox Recipients to those associated with the provided Lockbox Address.
- `created_at.after` string, date-time — Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.before` string, date-time — Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.on_or_after` string, date-time — Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `created_at.on_or_before` string, date-time — Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
- `idempotency_key` string — Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).

## Response `200`

Lockbox Recipient List

- LockboxRecipientList — A list of Lockbox Recipient objects.
  - `data` LockboxRecipient[], required — The contents of the list.
    - `account_id` string, required — The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.
    - `created_at` string, date-time, required — The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox Recipient was created.
    - `description` string, nullable, required — The description of the Lockbox Recipient.
    - `id` string, required — The Lockbox Recipient identifier.
    - `idempotency_key` string, nullable, required — The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
    - `lockbox_address_id` string, required — The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.
    - `mail_stop_code` string, required — The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Address. It should be included in the mailing address intended for this Lockbox Recipient.
    - `recipient_name` string, nullable, required — The name of the Lockbox Recipient.
    - `status` 'active' | 'disabled' | 'canceled', nullable, required — The status of the Lockbox Recipient.
    - `type` 'lockbox_recipient', required — A constant representing the object's type. For this resource it will always be `lockbox_recipient`.
  - `next_cursor` string, nullable, required — A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.

## Other responses

- `4XX` — Error
- `5XX` — Error

---

[API](https://skmtc.net/increase/apis/increase-api-2.md) · [All operations](https://skmtc.net/increase/apis/increase-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/increase/increase-api-2/versions/e968bcd4dcf9/schema)