GET All Clients - Daftra API Docs

Retrieves a paginated list of all clients. The response includes both client data and pagination information.

Parameters:

limit: Number of records per page (1-1000)

page: Page number for pagination

search: Optional search term to filter results (name, email, phone, etc.)

client_type: Optional filter by client type (1: individual, 2: business)

sort: Optional field to sort by (id, name, created, etc.)

direction: Optional sort direction (asc or desc)

Response:

{
  "result": "success",
  "code": 200,
  "data": [
    {
      "Client": {
        "id": 15,
        "type": 2,
        "business_name": "ACME Corp",
        "first_name": "John",
        "last_name": "Doe",
        "email": "john.doe@example.com",
        "phone1": "555-1234",
        "address1": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country_code": "US",
        "created": "2023-01-15 10:30:22",
        "modified": "2023-03-10 14:25:18"
        // Additional client fields...
      }
    },
    // Additional clients...
  ],
  "pagination": {
    "page": 1,
    "page_count": 4,
    "total_results": 78,
    "prev": null,
    "next": "/api2/clients.json?page=2"
  }
}

{ "result": "success", "code": 200, "data": [ { "Client": { "id": 15, "type": 2, "business_name": "ACME Corp", "first_name": "John", "last_name": "Doe", "email": "john.doe@example.com", "phone1": "555-1234", "address1": "123 Main St", "city": "New York", "state": "NY", "postal_code": "10001", "country_code": "US", "created": "2023-01-15 10:30:22", "modified": "2023-03-10 14:25:18", "balance": 250, "active": 1 } }, { "Client": { "id": 16, "type": 2, "business_name": "Global Industries Ltd.", "first_name": "Jane", "last_name": "Smith", "email": "jane.smith@globalindustries.com", "phone1": "555-5678", "address1": "456 Corporate Blvd", "city": "Chicago", "state": "IL", "postal_code": "60601", "country_code": "US", "created": "2023-01-20 09:15:45", "modified": "2023-03-15 11:20:36", "balance": 1200, "active": 1 } } ], "pagination": { "page": 1, "page_count": 4, "total_results": 78, "prev": null, "next": "/api2/clients.json?page=2" } }

Request

Query Params

limit

string

required

Number of records to return per page (1-1000)

Example:

page

string

required

Page number for pagination

Example:

string

required

Search term to filter results (name, email, phone, etc.)

client_type

string

required

Filter by client type (1: individual, 2: business)

sort

string

required

Field to sort by (id, name, created, etc.)

Example:

direction

string

required

Sort direction (asc or desc)

Example:

desc

Responses

🟢200Success Response

application/json

Body

result

string

required

code

integer

required

data

array [object {1}]

required

Client

object

required

pagination

object

required

page

integer

required

page_count

integer

required

total_results

integer

required

null

required

string

required