---
title: "POST /v1/robot-ids/list"
method: POST
path: "/v1/robot-ids/list"
tags: ["Fleet Management"]
---

# POST /v1/robot-ids/list

`POST /v1/robot-ids/list`

## Request

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

Return a list of robot IDs the user has access to, filtered by optional
 criteria.

 The list includes all known robots, regardless of their current connection
 status.

## Request body

- ListRobotIDsRequest: Request object for listing robot IDs
  - `filter` RobotFilter: RobotFilter defines a filter for selecting robots.
    - `locationId` string: An empty location_id returns all robots authorized to the authenticated API key user.

## Response `200`

OK

- ListRobotIDsResponse
  - `totalRobots` integer
  - `robotIds` string[]: This might not have all the robot IDs if there are too many. It will have all the robot IDs if the number of robot_ids is same as total_robots.

## 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)