Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-2082100373.0 KB

8446023e02fb

lockboxes

List Lockboxes

List lockboxes for your account.

A Lockbox represents a vendor that receives physical mail and scans checks on Chariot's behalf. Lockboxes are the source of Mail Items, which in turn produce Donations and Deposits. Lockboxes are provisioned and managed by Chariot.

get/v1/lockboxes

Query parameters

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

page_tokenstring

The cursor to use for pagination. If not set, the first page of results will be returned.

Response

The response for Lockboxes.list

next_page_tokenstring

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Example response

{
  "results": [
    {
      "id": "lockbox_01j8rs605a4gctmbm58d87mvsj",
      "address": {
        "city": "New York",
        "country": "US",
        "line1": "123 Main St.",
        "line2": "Suite 2504",
        "postal_code": "12345",
        "state": "NY"
      },
      "created_at": "2020-01-31T23:59:59Z",
      "updated_at": "2020-01-31T23:59:59Z"
    }
  ]
}