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

Query parameter: cursor for List Locations

limitoptional integer

Query parameter: limit for List Locations

qoptional string

Query parameter: q for List Locations

include[]optional arrayenumValues:parentchildren

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

objectstringenumValues:list

Object type for Location list

page_infoobject

Pagination metadata for Location list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of Location 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

Object type for Location list

page_infoobject

Pagination metadata for Location list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of Location 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

curl API_HOST/v1/operations/locations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1"

curl API_HOST/v1/operations/locations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1"

200 example

{
  "object": "list",
  "page_info": {
    "next_cursor": "lc_01gf7a8200er3ar3pkfrb6kk30",
    "prev_cursor": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "lc_01gf7a8200er3ar3pkfrb6kk30",
      "object": "location",
      "name": "Warehouse A",
      "type": "building",
      "parent": null,
      "children": {
        "object": "list",
        "page_info": {
          "next_cursor": null,
          "prev_cursor": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "id": "lc_01gf7a8200er3ar3pkfrb6kk32",
            "object": "location",
            "name": "Shelf A1",
            "type": "building",
            "parent": null,
            "children": null,
            "created_at": "0001-01-01T00:00:00Z",
            "updated_at": "0001-01-01T00:00:00Z"
          }
        ]
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_cursor": "lc_01gf7a8200er3ar3pkfrb6kk30",
    "prev_cursor": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "lc_01gf7a8200er3ar3pkfrb6kk30",
      "object": "location",
      "name": "Warehouse A",
      "type": "building",
      "parent": null,
      "children": {
        "object": "list",
        "page_info": {
          "next_cursor": null,
          "prev_cursor": null,
          "has_next_page": false,
          "has_prev_page": false
        },
        "data": [
          {
            "id": "lc_01gf7a8200er3ar3pkfrb6kk32",
            "object": "location",
            "name": "Shelf A1",
            "type": "building",
            "parent": null,
            "children": null,
            "created_at": "0001-01-01T00:00:00Z",
            "updated_at": "0001-01-01T00:00:00Z"
          }
        ]
      },
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Locations

Query Parameters

Returns

Responses