GET Single Client

Production

https://{{subdomain}}.daftra.com/api2

GET

/clients/{id}{format}

Returns a single client by ID, wrapped in a Client object.

Requires a permission that grants access to the client (viewing all clients, or being the assigned staff member for it). Returns 404 if no client matches the given ID.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Responses

🟢200OK

application/json

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://.daftra.com/api2/clients/' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "code": 200,
    "result": "successful",
    "data": {
        "Client": {
            "id": 512,
            "client_number": "0000715",
            "site_id": 0,
            "staff_id": 0,
            "is_offline": true,
            "business_name": "John Smith",
            "first_name": "string",
            "last_name": "string",
            "email": "user@example.com",
            "type": 2,
            "address1": "string",
            "address2": "string",
            "city": "string",
            "state": "string",
            "postal_code": "string",
            "phone1": "string",
            "phone2": "string",
            "country_code": "str",
            "national_id": "string",
            "notes": "string",
            "active_secondary_address": true,
            "secondary_name": "string",
            "secondary_address1": "string",
            "secondary_address2": "string",
            "secondary_city": "string",
            "secondary_state": "string",
            "secondary_postal_code": "string",
            "secondary_country_code": "string",
            "language_code": 0,
            "default_currency_code": "strin",
            "category": "string",
            "category_id": 0,
            "group_price_id": 0,
            "follow_up_status": 0,
            "secondary_follow_up_status": 0,
            "starting_balance": 0,
            "credit_limit": 0,
            "credit_period": 0,
            "timezone": 0,
            "branch_id": 1,
            "gender": 0,
            "birth_date": "2019-08-24",
            "photo": "string",
            "map_location": "string",
            "link": "string",
            "bn1": "string",
            "bn1_label": "string",
            "bn2": "string",
            "bn2_label": "string",
            "suspend": true,
            "last_login": "2019-08-24T14:15:22.123Z",
            "last_ip": "string",
            "original_site_id": 0,
            "created": "2019-08-24T14:15:22.123Z",
            "modified": "2019-08-24T14:15:22.123Z",
            "CustomModel": {
                "property1": "string",
                "property2": "string"
            }
        }
    }
}

GET All Clients

Add New Client