Skip to main content
GET
/
storedAddresses
List stored addresses
curl --request GET \
  --url https://api.quivo.co/storedAddresses
[
  {
    "id": 123,
    "version": 123,
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "address": {
      "name1": "<string>",
      "name2": "<string>",
      "company": "<string>",
      "address1": "<string>",
      "address2": "<string>",
      "address3": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "phone": "<string>",
      "email": "<string>",
      "identifierType": "GLN",
      "identifier": "<string>",
      "additionalAddressIdentifiers": [
        {
          "type": "GLN",
          "identifier": "<string>"
        }
      ],
      "empty": true
    },
    "deletedAt": "2023-11-07T05:31:56Z",
    "sort": "<string>",
    "typeId": "<string>"
  }
]

Query Parameters

​
query
string

Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.

​
sort
string

Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').

​
page
integer<int64>

The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.

​
searchAfter
string

Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.

​
pageSize
integer<int64>

The maximum number of items to return per page. Used for both offset and cursor-based pagination.

Response

Returns an array of stored addresses available to the account.

​
id
integer<int64>

The unique identifier for the id

​
version
integer<int64>

The version numeric value

​
created
string<date-time>

Timestamp when the item was created

​
lastModified
string<date-time>

Timestamp when the item was last modified

​
address
object

Address information including street, city, country, and postal code

​
deletedAt
string<date-time>

The deleted at timestamp

​
sort
string

The sort value

​
typeId
string

The unique identifier for the type