Skip to content

List locations

Request

Retrieve a paginated list of active locations for the account. Supports filtering by name and storeId. Use storeId filter to find a location by partner's external identifier.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

Query
namestring, [ 0 .. 100 ] characters

Filter locations by name (case-insensitive contains match)

Example:name=Main Street
storeIdstring, [ 0 .. 100 ] characters

Filter by exact storeId (partner's external identifier)

Example:storeId=STORE123
sortBystring(?i)NAME|CREATED_DATE

Sort by field

Default:"NAME"
Enum:"NAME""CREATED_DATE"
sortDirstring(?i)ASC|DESC

Sort direction

Default:"ASC"
Enum:"ASC""DESC"
cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20
Example:limit=20
activeboolean

Filter by active status. If not specified, returns both active and inactive locations.

Enum:truefalse
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location?name=Main%20Street&storeId=STORE123&sortBy=NAME&sortDir=ASC&cursor=string&limit=20&active=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Locations retrieved successfully

Bodyapplication/json
locationsArray of objects(LocationDTO)

List of locations in this page

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

Example:"eyJ2Ijp7Im5hbWUiOiJNYWluIFN0cmVldCJ9LCJpZCI6MTIzNDV9"
Response
{
  "locations": [
    { … }
  ],
  "nextCursor": "eyJ2Ijp7Im5hbWUiOiJNYWluIFN0cmVldCJ9LCJpZCI6MTIzNDV9"
}