Skip to main content
GET
/
api
/
org
/
v1
/
locations
List Locations
curl --request GET \
  --url https://console.lomaplatform.com/api/org/v1/locations \
  --header 'API-Key: <api-key>'
[
  {
    "id": "OBG47x1f4pGq",
    "external_id": "LOC_1",
    "name": "Test Location 1",
    "address_line_1": "123 Smith Road",
    "address_line_2": null,
    "address_city": "Atlanta",
    "address_state": "Georgia",
    "address_zip": "12345",
    "date_opened": "2023-11-28",
    "created_at": "2023-11-28 16:10:38.65394+00",
    "updated_at": "2024-05-29 16:02:08.543+00"
  },
  {
    "id": "uPY8HK8As3Kg",
    "external_id": null,
    "name": "Test Location 2",
    "address_line_1": "456 Apple Road",
    "address_line_2": "",
    "address_city": "Chicago",
    "address_state": "IL",
    "address_zip": "12345",
    "date_opened": null,
    "created_at": "2023-11-28 16:10:38.65394+00",
    "updated_at": "2024-05-29 16:02:08.543+00"
  }
]

Authorizations

​
API-Key
string
header
required

API Key for the organization

Query Parameters

​
page
number
default:1
Required range: x >= 1
​
limit
number
default:100
Required range: 1 <= x <= 1000
​
sort
enum<string>
default:name
Available options:
name,
created_at,
updated_at
​
direction
enum<string>
default:asc
Available options:
asc,
desc

Response

200 OK

​
id
string
required
​
external_id
string | null
required
​
name
string
required
​
address_line_1
string
required
​
address_line_2
string | null
required
​
address_city
string
required
​
address_state
string
required
​
address_zip
string
required
​
date_opened
string | null
required
​
created_at
string
required
​
updated_at
string
required
⌘I