# List orders

**GET** `/orders`

## Parameters

### `limit` (_query_, optional)

Page size (max 100)

- **Type:** `integer`
- **Default:** `50`
- **Example:** `50`
- **Constraints:** >= 1, <= 100

### `offset` (_query_, optional)

Number of items to skip

- **Type:** `integer`
- **Default:** `0`
- **Example:** `0`
- **Constraints:** >= 0

## Responses

### 200

Paginated orders

**application/json**

_Schema ref:_ `#/components/schemas/ListOrdersResponse` (ListOrdersResponse)

```json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_id": {
            "type": "integer"
          },
          "client_status": {
            "type": "string",
            "enum": [
              "RECEIVED",
              "BEING_PROCESSED",
              "FINANCING_REQUEST",
              "DOC_REQUIRED",
              "SIGNING",
              "PROCESSING",
              "SHIPPED",
              "RECEPTION_TO_CONFIRM",
              "ONGOING_ORDER",
              "PENDING_DECISION",
              "EQUIPMENT_TO_SEND",
              "ARCHIVED",
              "FAILED",
              "UNKNOWN"
            ],
            "description": "Order progress key for display and filtering",
            "example": "BEING_PROCESSED"
          },
          "device_names": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Display names for devices on the order"
          },
          "rent": {
            "type": "string",
            "nullable": true
          },
          "rent_currency": {
            "type": "string",
            "nullable": true
          },
          "order_number": {
            "type": "string",
            "nullable": true
          },
          "contract_number": {
            "type": "string",
            "nullable": true
          },
          "order_date": {
            "type": "string",
            "nullable": true
          },
          "num_devices": {
            "type": "integer",
            "nullable": true
          },
          "fulfillment_mode": {
            "type": "string",
            "enum": [
              "DIRECT_DELIVERY",
              "STOCK"
            ],
            "description": "DIRECT_DELIVERY ships devices to their users; STOCK ships them to the company's stock"
          },
          "created_at": {
            "type": "string",
            "nullable": true
          },
          "updated_at": {
            "type": "string",
            "nullable": true
          }
        },
        "required": [
          "order_id",
          "client_status",
          "device_names",
          "rent",
          "rent_currency",
          "order_number",
          "contract_number",
          "order_date",
          "num_devices",
          "fulfillment_mode",
          "created_at",
          "updated_at"
        ]
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer",
          "description": "Total items matching filters (before paging)",
          "example": 42
        },
        "limit": {
          "type": "integer",
          "description": "Page size used for this response",
          "example": 50
        },
        "offset": {
          "type": "integer",
          "description": "Offset used for this response",
          "example": 0
        }
      },
      "required": [
        "total",
        "limit",
        "offset"
      ]
    }
  },
  "required": [
    "data",
    "meta"
  ]
}
```

### 400

Validation error

**application/json**

_Schema ref:_ `#/components/schemas/ValidationErrorResponse` (ValidationErrorResponse)

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Every validation failure, comma-separated",
      "example": "Required, must be an ISO 3166-1 alpha-2 country code"
    },
    "type": {
      "type": "string",
      "enum": [
        "validation_error"
      ]
    },
    "error": {
      "type": "string",
      "enum": [
        "validation_error"
      ]
    }
  },
  "required": [
    "message",
    "type",
    "error"
  ]
}
```

### 401

Missing, invalid, or revoked API key

**text/plain**

```json
{
  "type": "string",
  "example": "Unauthorized"
}
```

### 429

Rate limit exceeded. The RateLimit-* headers give the limit and the reset time.

**text/plain**

```json
{
  "type": "string",
  "example": "Too many requests, please try again later."
}
```

### 500

Unexpected server error

**application/json**

_Schema ref:_ `#/components/schemas/InternalErrorResponse` (InternalErrorResponse)

```json
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "enum": [
        "INTERNAL_ERROR"
      ]
    }
  },
  "required": [
    "error"
  ]
}
```

### 503

Rate limiting is temporarily unavailable; retry with backoff

**application/json**

_Schema ref:_ `#/components/schemas/RateLimiterUnavailableResponse` (RateLimiterUnavailableResponse)

```json
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "required": [
    "message"
  ]
}
```

## Security

```json
[
  {
    "bearerAuth": []
  }
]
```

**bearerAuth:** Bearer token using a Fleet platform API key (flt_sk_…).

---

_Generated from the OpenAPI specification for raw Markdown / tooling use._
