List Locations

Beta

GET/v1/operations/locations

This endpoint is idempotent. Learn more

Returns a paginated list of locations for the caller's account.

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.

include[]optional arrayenumValues:parentchildren

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

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

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectExpandablenullable

Parent location. Null for top-level locations. Expandable.

idstring

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

Always returned as null in this endpoint.

childrenobjectnullable

Child locations. Expandable.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

childrenobjectExpandablenullable

Child locations. Expandable.

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

Location ID.

objectstringenumValues:location

Resource type identifier.

namestring

Display name.

typestringenumValues:buildingsectionaisle

Location type code.

parentobjectnullable

Parent location. Null for top-level locations. Expandable.

Always returned as null in this endpoint.

childrenobjectnullable

Child locations. Expandable.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last-updated timestamp.

Responses

200

Successful response for List Locations

List Locations

import Augno from '@augno/sdk';

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

const listLocation = await client.operations.locations.list();

console.log(listLocation.data);

import Augno from '@augno/sdk';

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

const listLocation = await client.operations.locations.list();

console.log(listLocation.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/locations?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibGNfMDE0ZDE4N2Q5OWIzMTkyNmYwYzc0YWY5ZDgiLCJkIjoiZiJ9.v6V9YKMCW1qcwrh2ZT5tUJealoF0hFxSqd9j7UoOJM0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "lc_014d187d99b31926f0c74af9d8",
      "object": "location",
      "name": "Warehouse A",
      "type": "building",
      "children": {
        "object": "list",
        "page_info": {
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "id": "lc_0132c4db1e220da9bc596cc4c9",
            "object": "location",
            "name": "Shelf A1",
            "type": "building"
          }
        ]
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/locations?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoibGNfMDE0ZDE4N2Q5OWIzMTkyNmYwYzc0YWY5ZDgiLCJkIjoiZiJ9.v6V9YKMCW1qcwrh2ZT5tUJealoF0hFxSqd9j7UoOJM0",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "lc_014d187d99b31926f0c74af9d8",
      "object": "location",
      "name": "Warehouse A",
      "type": "building",
      "children": {
        "object": "list",
        "page_info": {
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "id": "lc_0132c4db1e220da9bc596cc4c9",
            "object": "location",
            "name": "Shelf A1",
            "type": "building"
          }
        ]
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Locations

Query Parameters

Returns

Responses