Skip to content

List Clients

Retrieve a paginated list of all clients (end users) registered with the agency. This endpoint provides customer relationship management capabilities, allowing staff to view client profiles, verification status, and booking statistics.

Each client entry includes:

  • Contact Information: Name, email, phone, and avatar
  • Verification Status: Whether email, phone, and documents are verified
  • Activity Statistics: Total bookings, active bookings, and lifetime spending
  • Account Status: Active, suspended, or unverified

Use this endpoint for:

  • Customer support to look up client accounts
  • Identifying clients needing verification follow-up
  • Reviewing client booking history and spending patterns
  • Managing suspended or problematic accounts

Endpoint

INFO

GET /api/v1/dashboard/clients

Headers

HeaderValueRequired
Acceptapplication/jsonYes
AuthorizationBearer {token}Yes

Query Parameters

ParameterTypeDefaultDescription
searchstring-Search by name, email, or phone
statusstring-Filter: active, suspended, unverified
verifiedboolean-Filter by verification status
pageinteger1Page number
per_pageinteger15Items per page

Example Request

bash
curl -X GET "https://api.daakey.com/api/v1/dashboard/clients?status=active&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}"

Response

Success (200)

json
{
  "success": true,
  "message": "Clients retrieved",
  "data": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com",
      "phone": "+1234567890",
      "avatar_url": "https://api.daakey.com/storage/avatars/1.jpg",
      "status": "active",
      "verified": {
        "email": true,
        "phone": true,
        "documents": true
      },
      "stats": {
        "total_bookings": 15,
        "active_bookings": 1,
        "total_spent": 1250.00
      },
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 10,
    "per_page": 15,
    "total": 150
  },
  "request_id": "uuid",
  "timestamp": "2024-01-01T00:00:00.000Z"
}

Daakey Car Sharing Platform