Manage Riders
Get Riders
REST API Documentation
Manage Riders
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
Query Parameters
Description:
| Field | Type | Required | Description |
|---|---|---|---|
paginate | string | ||
per_page | string | ||
active | string | ||
get_ongoing_deliveries | string | ||
pending_invites | string |
📤 Response
✅ 200 OK
❌ 422 Bad Request
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 |