List Partners
Retrieve a paginated list of all partners in the Daakey platform. Partners are the top-level organizational entities that can manage multiple agencies, each with their own fleet of vehicles.
This endpoint is primarily used by super administrators to manage the platform's partner network. Each partner entry includes aggregate statistics like the number of agencies they manage and total vehicles in their fleet.
Use cases include:
- Displaying a partners overview table in the admin dashboard
- Searching for specific partners by name or code
- Filtering partners by active/inactive status
- Reviewing partner fleet sizes for business analytics
Permission Required
This endpoint requires the partners.view permission. Only super administrators typically have access to partner management features.
Endpoint
INFO
GET /api/v1/dashboard/partners
Headers
| Header | Value | Required |
|---|---|---|
Accept | application/json | Yes |
Authorization | Bearer {token} | Yes |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
search | string | - | Search by name or code |
status | string | - | Filter by status: active, inactive |
page | integer | 1 | Page number |
per_page | integer | 15 | Items per page (max: 100) |
Example Request
bash
curl -X GET "https://api.daakey.com/api/v1/dashboard/partners?page=1&per_page=20" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"Response
Success (200)
json
{
"success": true,
"message": "Partners retrieved",
"data": [
{
"id": 1,
"name": "Acme Car Rentals",
"code": "ACME001",
"email": "contact@acme.com",
"phone": "+1234567890",
"status": "active",
"agencies_count": 5,
"vehicles_count": 120,
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": 2,
"name": "City Mobility",
"code": "CITYMOB",
"email": "info@citymobility.com",
"phone": "+0987654321",
"status": "active",
"agencies_count": 3,
"vehicles_count": 75,
"created_at": "2024-02-15T00:00:00Z"
}
],
"meta": {
"current_page": 1,
"last_page": 2,
"per_page": 20,
"total": 25
},
"request_id": "uuid",
"timestamp": "2024-01-01T00:00:00.000Z"
}Error (403)
json
{
"success": false,
"message": "Unauthorized",
"data": null,
"request_id": "uuid",
"timestamp": "2024-01-01T00:00:00.000Z"
}