Skip to content

List rooms

Request

Retrieve rooms for the location. Supports filtering by active status.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query
activeboolean

Filter by active status

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
curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/room?active=true&sortBy=NAME&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Rooms retrieved successfully

Bodyapplication/json
nextCursorstring

Opaque cursor for fetching the next page

roomsArray of objects(RoomDTO)

List of rooms

Response
{ "nextCursor": "string", "rooms": [ {} ] }