List Addresses

Beta

GET/v1/sales/addresses

This endpoint is idempotent. Learn more

Returns a paginated list of addresses.

cursoroptional string

Cursor token used to retrieve the next or previous page of results.

limitoptional integer

Maximum number of results per page (default: 100, max: 1000).

qoptional string

Search query used to filter results.

typeoptional stringenumValues:standarddrop_ship

Filter by address type.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

Address type.

geolocationobjectnullable

Geolocation details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Addresses

List Addresses

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAddress = await client.sales.addresses.list();

console.log(listAddress.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listAddress = await client.sales.addresses.list();

console.log(listAddress.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/addresses?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWRfMDEyMTAwOTUwY2ZhYTM0YWEwZTBhZDcyNTgiLCJkIjoiZiJ9.mTJayI74g0GvTp4GNj-HiZOxu9eh_WpKiDDLz80UK5k",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ad_012100950cfaa34aa0e0ad7258",
      "object": "address",
      "name": "Headquarters",
      "type": "standard",
      "geolocation": {
        "id": "gl_013e4c26412103c6757ba71806",
        "object": "geolocation",
        "street_line_1": "4200 Industrial Pkwy",
        "locality": "Columbus",
        "state": "OH",
        "postal_code": "43204",
        "country": "US"
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/sales/addresses?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWRfMDEyMTAwOTUwY2ZhYTM0YWEwZTBhZDcyNTgiLCJkIjoiZiJ9.mTJayI74g0GvTp4GNj-HiZOxu9eh_WpKiDDLz80UK5k",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ad_012100950cfaa34aa0e0ad7258",
      "object": "address",
      "name": "Headquarters",
      "type": "standard",
      "geolocation": {
        "id": "gl_013e4c26412103c6757ba71806",
        "object": "geolocation",
        "street_line_1": "4200 Industrial Pkwy",
        "locality": "Columbus",
        "state": "OH",
        "postal_code": "43204",
        "country": "US"
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Addresses

Query Parameters

Returns

Responses