> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usedora.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Riders

### 📝 Summary

This endpoint retrieves a list of all riders in the system, along with relevant details such as their status, assigned tasks, and other metadata. It supports optional filters and pagination for more efficient data retrieval.

***

### Requests

##### Params

<Expandable>
  **Description:**

  | Name                     | Location | Type      | Required | Description |
  | ------------------------ | -------- | --------- | -------- | ----------- |
  | `paginate`               | query    | \[string] | yes      | none        |
  | `per_page`               | query    | \[string] | yes      | none        |
  | `active`                 | query    | \[string] | yes      | none        |
  | `get_ongoing_deliveries` | query    | \[string] | yes      | none        |
  | `pending_invites`        | query    | \[string] | yes      | none        |
</Expandable>

### Responses

| HTTP Status Code                 | Meaning                                                          | Description | Data schema |
| -------------------------------- | ---------------------------------------------------------------- | ----------- | ----------- |
| <Badge color="green">200</Badge> | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)          | none        | Inline      |
| <Badge color="red">422</Badge>   | [Bad Request](https://tools.ietf.org/html/rfc7231#section-6.3.1) | none        | Inline      |

<Expandable>
  **Description:**

  | **Field**                                                                         | **Type**      | **Required** | **Description** |   |
  | --------------------------------------------------------------------------------- | ------------- | -----------: | --------------- | - |
  | `data`                                                                            | object        |              |                 |   |
  | `data.riders`                                                                     | object        |              |                 |   |
  | `data.riders`                                                                     | object        |              |                 |   |
  | `data.riders.current_page`                                                        | number        |              |                 |   |
  | `data.riders.data`                                                                | object        |              |                 |   |
  | `data.riders.data.active`                                                         | boolean       |              |                 |   |
  | `data.riders.data.address`                                                        | string        |              |                 |   |
  | `data.riders.data.created_at`                                                     | string        |              |                 |   |
  | `data.riders.data.email`                                                          | string        |              |                 |   |
  | `data.riders.data.name`                                                           | string        |              |                 |   |
  | `data.riders.data.number_of_ongoing_deliveries`                                   | number        |              |                 |   |
  | `data.riders.phone_code`                                                          | string        |              |                 |   |
  | `data.riders.phone_number`                                                        | string        |              |                 |   |
  | `data.riders.photo`                                                               | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries`                                       | object        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.created_at`                            | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.customer_detail`                       | object        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.customer_detail.created_at`            | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.customer_detail.customer_address`      | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.customer_detail.customer_name`         | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.customer_detail.customer_phone_number` | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.customer_detail.uuid`                  | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.customer_longitude`                    | any / null    |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.delivery_fee`                          | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.delivery_type`                         | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.fleet_identity_number`                 | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.items`                                 | object        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.items.created_at`                      | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.items.currency`                        | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.items.item_description`                | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.items.item_quantity`                   | number        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.items.item_value`                      | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.items.uuid`                            | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.note`                                  | any / null    |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.order_number`                          | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_detail`                         | object        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_detail.created_at`              | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_detail.sender_address`          | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_detail.sender_email`            | any / null    |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_detail.sender_name`             | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_detail.sender_phone`            | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_detail.sender_phonecode`        | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_detail.updated_at`              | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_latitude`                       | any / null    |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.sender_longitude`                      | any / null    |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.status`                                | string        |              |                 |   |
  | `data.riders.data.rider_ongoing_deliveries.uuid`                                  | string        |              |                 |   |
  | `data.riders.data.riderid`                                                        | string        |              |                 |   |
  | `data.riders.data.total_completed_delivery`                                       | number        |              |                 |   |
  | `data.riders.data.total_revenue_by_rider`                                         | any / null    |              |                 |   |
  | `data.riders.data.uuid`                                                           | string        |              |                 |   |
  | `data.riders.data.vehicle_plate_number`                                           | string        |              |                 |   |
  | `data.riders.first_page_url`                                                      | string        |              |                 |   |
  | `data.riders.from`                                                                | number        |              |                 |   |
  | `data.riders.last_page`                                                           | number        |              |                 |   |
  | `data.riders.last_page_url`                                                       | string        |              |                 |   |
  | `data.riders.links`                                                               | object        |              |                 |   |
  | `data.riders.links.active`                                                        | boolean       |              |                 |   |
  | `data.riders.links.label`                                                         | string        |              |                 |   |
  | `data.riders.links.url`                                                           | string / null |              |                 |   |
  | `data.riders.next_page_url`                                                       | any / null    |              |                 |   |
  | `data.riders.path`                                                                | string        |              |                 |   |
  | `data.riders.per_page`                                                            | number        |              |                 |   |
  | `data.riders.prev_page_url`                                                       | any /null     |              |                 |   |
  | `data.riders.to`                                                                  | number        |              |                 |   |
  | `data.riders.total`                                                               | number        |              |                 |   |
  | `data.total_active_riders`                                                        | number        |              |                 |   |
  | `data.total_deactivated_riders`                                                   | number        |              |                 |   |
  | `data.total_number_of_fulfilled_orders`                                           | number        |              |                 |   |
  | `data.total_number_of_riders`                                                     | number        |              |                 |   |
  | `data.total_revenue`                                                              | number        |              |                 |   |
  | `status`                                                                          | string        |              |                 |   |
</Expandable>

<ResponseExample>
  ```json sample response theme={null}
  {
  "status": "success",
  "data": {
      "total_number_of_riders": 2,
      "total_active_riders": 1,
      "total_deactivated_riders": 1,
      "total_number_of_fulfilled_orders": 0,
      "total_revenue": 0,
      "riders": {
          "current_page": 1,
          "data": [
              {
                  "uuid": "69234d24-61c1-4d68-a232-7a04d71f2b0e",
                  "riderid": "71762164",
                  "name": "Kelly Chimaobi",
                  "address": "Aso housing estate, lugbe",
                  "phone_number": "07081131771",
                  "phone_code": "234",
                  "email": "kyl@gmail.com",
                  "vehicle_plate_number": "Ae93480G",
                  "photo": "https://usedora-bucket-dev.s3.amazonaws.com/photos/S97Eie0RU6bdafmq5OjV9HeZkuCYdL0UNaT4SP52.jpg",
                  "total_completed_delivery": 0,
                  "active": false,
                  "number_of_ongoing_deliveries": 1,
                  "total_revenue_by_rider": null,
                  "rider_ongoing_deliveries": [
                      {
                          "uuid": "4560f59a-d071-4854-a098-2978ba373004",
                          "order_number": "14192541",
                          "fleet_identity_number": "68316349",
                          "status": "Awaiting-Pickup",
                          "delivery_type": "intra_state",
                          "sender_longitude": null,
                          "sender_latitude": null,
                          "customer_longitude": null,
                          "customer_latitude": null,
                          "delivery_fee": "NGN3,000.00",
                          "note": null,
                          "created_at": "2024-01-06T17:02:09.000000Z",
                          "customer_detail": {
                              "uuid": "21803e28-08b7-4b23-b3f6-49161f8a6a4c",
                              "customer_name": "TundeNasri",
                              "customer_email": null,
                              "customer_phone_number": "08065302534",
                              "customer_phone_code": "234",
                              "customer_address": "12 Ahmadu Bello way, Central Business District, Abuja",
                              "created_at": "2024-01-06T07:28:13.000000Z"
                          },
                          "sender_detail": {
                              "uuid": "62c70575-366c-44c3-893e-504abce1f667",
                              "sender_name": "Nuel Geek",
                              "sender_phone": "08087168391",
                              "sender_email": null,
                              "sender_phonecode": "234",
                              "sender_address": "2 Umuleri street, Lagos",
                              "created_at": "2024-01-06T17:02:09.000000Z",
                              "updated_at": "2024-01-06T17:03:26.000000Z"
                          },
                          "items": [
                              {
                                  "uuid": "99594223-8c39-49be-aefb-a1704e2e2650",
                                  "item_description": "Packaged makeup for mama emma's birthday celebration",
                                  "item_quantity": 2,
                                  "item_value": "43500.00",
                                  "currency": "NGN",
                                  "created_at": "2024-01-06T17:02:09.000000Z"
                              },
                              {
                                  "uuid": "801f2638-4a26-444d-9409-c5f54667e449",
                                  "item_description": "Eva soap pack",
                                  "item_quantity": 1,
                                  "item_value": "4000.00",
                                  "currency": "NGN",
                                  "created_at": "2024-01-06T17:03:26.000000Z"
                              },
                              {
                                  "uuid": "68751dcf-4440-4b51-9dbc-9e161b21ce2b",
                                  "item_description": "Cannon Camera",
                                  "item_quantity": 1,
                                  "item_value": "30000.00",
                                  "currency": "NGN",
                                  "created_at": "2024-01-06T17:03:26.000000Z"
                              }
                          ]
                      }
                  ],
                  "created_at": "2024-01-06T08:02:20.000000Z"
              }
          ],
          "first_page_url": "http://127.0.0.1:8000/api/riders?page=1",
          "from": 1,
          "last_page": 1,
          "last_page_url": "http://127.0.0.1:8000/api/riders?page=1",
          "links": [
              {
                  "url": null,
                  "label": "&laquo; Previous",
                  "active": false
              },
              {
                  "url": "http://127.0.0.1:8000/api/riders?page=1",
                  "label": "1",
                  "active": true
              },
              {
                  "url": null,
                  "label": "Next &raquo;",
                  "active": false
              }
          ],
          "next_page_url": null,
          "path": "http://127.0.0.1:8000/api/riders",
          "per_page": 10,
          "prev_page_url": null,
          "to": 1,
          "total": 1
      }
  }
  }
  ```
</ResponseExample>
