List Addresses

Beta

GET/v1/sales/addresses

This endpoint is idempotent. Learn more

Returns a paginated list of addresses.

Addresses belonging to the account you are acting in are returned newest first. The q search term matches the address name, street lines, city, state, postal code, and country.

Permissions requiredValues:addresses:readcustomers:readsuppliers:read

The role behind your API key or agent must grant every one of these permissions.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

typeoptional stringenumValues:standarddrop_ship

Filters results to addresses of the given type.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of address

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

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

The most specific link in the receiving chain: set it when one of a customer's sites keeps different days from the rest. Null falls through to the customer, then their group, then the account default.

geolocationgeolocationnullable

Street-level location 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 OpenMRP from '@openmrp/sdk';

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

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

console.log(listAddress.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  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=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWRfajhjejBiNzlwd2RiIiwiZCI6ImYifQ.wiInXiZuyqWwxg7UUMF3L4y5svBeTI3oKBpd4JOGhwY",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ad_j8cz0b79pwdb",
      "object": "address",
      "name": "Headquarters",
      "phone": "+1-614-555-0142",
      "email": "receiving@acme.example.com",
      "type": "standard",
      "receive_calendar_id": null,
      "geolocation": {
        "id": "gl_betrf3v346k5",
        "object": "geolocation",
        "street_line_1": "4200 Industrial Pkwy",
        "street_line_2": null,
        "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=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiYWRfajhjejBiNzlwd2RiIiwiZCI6ImYifQ.wiInXiZuyqWwxg7UUMF3L4y5svBeTI3oKBpd4JOGhwY",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "ad_j8cz0b79pwdb",
      "object": "address",
      "name": "Headquarters",
      "phone": "+1-614-555-0142",
      "email": "receiving@acme.example.com",
      "type": "standard",
      "receive_calendar_id": null,
      "geolocation": {
        "id": "gl_betrf3v346k5",
        "object": "geolocation",
        "street_line_1": "4200 Industrial Pkwy",
        "street_line_2": null,
        "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

Authorization

Query Parameters

Returns

Responses