---
title: "POST /v1/location-info/get"
method: POST
path: "/v1/location-info/get"
tags: ["Locations & Maps"]
---

# POST /v1/location-info/get

`POST /v1/location-info/get`

## Request

- Base URL: `https://api.bearrobotics.ai`
- URL: `https://api.bearrobotics.ai/v1/location-info/get`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bearrobotics/apis/bear-cloud-api/docs/v1/location-info/get/post.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve information about a specific location by its ID.

 The location includes metadata such as floors, sections, and their
 associated maps.

 Note:
 - This does not require robot connectivity.

## Request body

- GetLocationInfoRequest: Request object for retrieving location information
  - `locationId` string, required: The location_id is a 4 character alphanumeric identifier for the location. Example: "3R0A"

## Response `200`

OK

- GetLocationInfoResponse
  - `location` Location: Location represents a physical location with multiple floors and sections, including metadata such as creation and modification timestamps.
    - `locationId` string: A 4 character alphanumeric identifier for the location. This is unique among all locations in a Universe. Example: "3R0A" Legacy locations may use the display_name as the identifier, in which case the identifier may be longer or shorter than 4 characters.
    - `createdTime` string, date-time: Timestamp indicating when the location was created.
    - `modifiedTime` string, date-time: Timestamp indicating the last time the location was modified.
    - `displayName` string: Display name of the location, matching the name shown in Universe. Examples: "City Deli & Grill", "KNTH"
    - `floors` object: Map of floors in the location, keyed by their floor level. The floor level is any non-negative integer starting from 0. Floor level is not necessarily sequential. Example: floors [ { key: 0 value: { display_name: "Ground Floor" sections: [...] } } { key: 1 value: { display_name: "Second Floor" sections: [...] } } { key: 99 value: { display_name: "Roof" sections: [...] } } ]

## Other responses

- `400`: Bad Request, usually caused by malfored request body.
- `401`: Unauthorized credentials, ensure the JWT is correct and up to date.
- `500`: Internal Server Error
- `503`: Service is temporarily unavailable, which can usually be resolved by backoff retries.
- `504`: Server-side timeout, usually caused by the failure to send/receive commands/responses to the designated robot.

---

[API](https://skmtc.dev/bearrobotics/apis/bear-cloud-api.md) - [All operations](https://skmtc.dev/bearrobotics/apis/bear-cloud-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bearrobotics/apis/bear-cloud-api/revisions/b90843b624b5?raw)