List all addresses
GET {{baseUrl}}/addresses
Returns a list of your addresses. The addresses are returned sorted by creation date, with the most recently created addresses appearing first.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | number | (optional) An integer that designates how many results to return. Defaults to 10 and must be no more than 100. | |
after | string | (optional) A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the previous_url field in the return response. | |
before | string | (optional) A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the next_url field in the return response. | |
date_created | string | (optional) Filter by ISO-8601 date or datetime, e.g. { gt: '2012-01-01', lt: '2012-01-31T12:34:56Z' } where gt is ›, lt is ‹, gte is ≥, and lte is ≤. | |
include[] | string | (optional) Request that the response include the total count by specifying include[]=total_count | |
metadata | string | (optional) Filter by metadata key-value pair, e.g. metadata[customer_id]=987654 |
RESPONSES
status: OK
{"data":[{"id":"adr_e68217bd744d65c8","description":"Harry - Office","name":"HARRY ZHANG","company":"LOB","phone":"5555555555","email":"harry@lob.com","address_line1":"185 BERRY ST STE 6100","address_line2":null,"address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2019-08-12T00:16:00.361Z","date_modified":"2019-08-12T00:16:00.361Z","object":"address"},{"id":"adr_830bf0eabdaaa409","description":"Harry - Office","name":"HARRY ZHANG","company":"LOB","phone":"5555555555","email":"harry@lob.com","address_line1":"185 BERRY ST STE 6100","address_line2":null,"address_city":"SAN FRANCISCO","address_state":"CA","address_zip":"94107-1741","address_country":"UNITED STATES","metadata":{},"date_created":"2019-08-07T21:59:46.764Z","date_modified":"2019-08-07T21:59:46.764Z","object":"address"}],"object":"list","next_url":"https://api.lob.com/v1/addresses?limit=2\u0026after=eyJkYXRlT2Zmc2V0IjoiMjAxOS0wOC0wN1QyMTo1OTo0Ni43NjRaIiwiaWRPZmZzZXQiOiJhZHJfODMwYmYwZWFiZGFhYTQwOSJ9","previous_url":null,"count":2}