Skip to main content
GET
/
customToAddresses
Retrieve All Custom To Addresses
curl --request GET \
  --url https://test.onlinecheckwriter.com/api/v3/customToAddresses \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "meta": {
      "total": 2
    },
    "addresses": [
      {
        "id": "5EJy7VeBQGzn1m3",
        "name": "John Doe",
        "companyName": "Company A",
        "addressLine1": "Address 1",
        "addressLine2": "Address 2",
        "city": "City",
        "state": "ST",
        "zip": "123456",
        "phone": "",
        "email": "[email protected]",
        "note": "Note."
      },
      {
        "id": "ZqRmA345OegdoLl",
        "name": "Jane Smith",
        "companyName": "Company B",
        "addressLine1": "Address 11",
        "addressLine2": "",
        "city": "City",
        "state": "ST",
        "zip": "123465",
        "phone": "",
        "email": "[email protected]",
        "note": "Main office address."
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
perPage
integer
default:10

Number of records to retrieve per page. Defaults to 10.

Example:

20

​
page
integer
default:1

Page number for pagination. Defaults to the first page.

Example:

2

Response

Custom 'to' addresses retrieved successfully.

​
success
boolean
Example:

true

​
data
object