> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Find waypoint runs by route run

> Find all waypoint runs for a given route run.

```http
POST https://api2.rhombussystems.com/api/robot/findWaypointRunsByRouteRun
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (header, required): Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
- `x-auth-scheme` (header, string, required, default: `api-token`): Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key. One of: `api-token`, `api`, `partner-api-token`, `partner-api`.

## Request body

Content type: `application/json`. Request to find waypoint runs for a given route run.

- `routeRunUuid` (string<RUUID> | null, required): base 64 (url-safe) uuid string

## Response 200

OK. Content type: `application/json`

- `error` (boolean | null)
- `errorMsg` (string | null)
- `warningMsg` (string | null)
- `waypointRuns` (array<object> | null): List of waypoint runs for the route run

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/robot/findWaypointRunsByRouteRun:
    post:
      description: Find all waypoint runs for a given route run.
      operationId: findWaypointRunsByRouteRun
      parameters:
        - description: Authentication scheme identifier. Use `api-token` for standard API key authentication, `partner-api-token` for partner API key authentication. Must be paired with the `x-auth-apikey` header containing your API key.
          example: api-token
          in: header
          name: x-auth-scheme
          required: true
          schema:
            default: api-token
            enum:
              - api-token
              - api
              - partner-api-token
              - partner-api
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Robot_FindWaypointRunsByRouteRunWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Robot_FindWaypointRunsByRouteRunWSResponse"
          description: OK
      summary: Find waypoint runs by route run
      tags:
        - Robot Webservice
components:
  schemas:
    Robot_FindWaypointRunsByRouteRunWSRequest:
      description: Request to find waypoint runs for a given route run.
      properties:
        routeRunUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      required:
        - routeRunUuid
      type: object
    Robot_FindWaypointRunsByRouteRunWSResponse:
      description: Response containing the waypoint runs for a route run.
      properties:
        error:
          nullable: true
          type: boolean
        errorMsg:
          nullable: true
          type: string
        warningMsg:
          nullable: true
          type: string
        waypointRuns:
          description: List of waypoint runs for the route run
          items:
            $ref: "#/components/schemas/WaypointRun"
          nullable: true
          type: array
      type: object
    WaypointRun:
      description: List of waypoint runs for the route run
      properties:
        actionStatusMap:
          additionalProperties:
            $ref: "#/components/schemas/WaypointActionProgress"
          nullable: true
          type: object
        arrivedAtEventUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        arrivedAtMs:
          format: int64
          nullable: true
          type: integer
        completedAtEventUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        completedAtMs:
          format: int64
          nullable: true
          type: integer
        createdAtMs:
          format: int64
          nullable: true
          type: integer
        deviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        dwellStrategy:
          $ref: "#/components/schemas/DwellStrategyEnum"
        dwellTimeMs:
          format: int64
          nullable: true
          type: integer
        name:
          nullable: true
          type: string
        ordinal:
          format: int32
          nullable: true
          type: integer
        orgUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        parentRouteRunUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        parentRouteUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        poseAchieved:
          $ref: "#/components/schemas/Pose"
        poseTarget:
          $ref: "#/components/schemas/Pose"
        routeWaypointUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        ruleReferences:
          items:
            description: base 64 (url-safe) uuid string
            example: AAAAAAAAAAAAAAAAAAAAAA
            format: RUUID
            nullable: true
            type: string
          nullable: true
          type: array
        startedAtEventUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        startedAtMs:
          format: int64
          nullable: true
          type: integer
        status:
          $ref: "#/components/schemas/RunStatusEnum"
        updatedAtMs:
          format: int64
          nullable: true
          type: integer
        uuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        waypointUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    WaypointActionProgress:
      properties:
        status:
          $ref: "#/components/schemas/WaypointActionStatusEnum"
        updatedAtMs:
          format: int64
          nullable: true
          type: integer
      type: object
    WaypointActionStatusEnum:
      enum:
        - NOT_STARTED
        - COMPLETED
        - ABORTED
        - UNKNOWN
      type: string
    DwellStrategyEnum:
      default: DURATION
      description: Strategy for how long the robot dwells at this waypoint
      enum:
        - NONE
        - DURATION
        - TIME_ABSOLUTE
        - EVENT
        - MANUAL
        - UNKNOWN
      type: string
    Pose:
      properties:
        orientation:
          items:
            description: Serialized as [x, y, z, w]
            format: double
            type: number
          maxItems: 4
          minItems: 4
          nullable: true
          type: array
        position:
          items:
            description: Serialized as [x, y, z]
            format: double
            type: number
          maxItems: 3
          minItems: 3
          nullable: true
          type: array
      type: object
    RunStatusEnum:
      enum:
        - PENDING
        - NAVIGATING
        - ARRIVED
        - COMPLETED
      type: string
  securitySchemes:
    ApiKeyAuth:
      description: Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````