Currently in the process of migrating from Apiary.

get

POST

/address-book/client/get

Get existing client from Backoffice. Client is found based on provided data in the request. At least one property is required.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://ext.kasamax.cz/ext/address-book/client/get' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "_id": "string",
    "externalId": "string",
    "email": "string",
    "phone": "string",
    "clientCardIdentifier": "string",
    "company": {
        "TIN": "string",
        "VATID": "string"
    }
}'

Response Example

{
    "isValid": true,
    "errors": [
        "string"
    ],
    "data": {
        "_id": "string",
        "externalId": "string",
        "clientCardIdentifier": "string",
        "email": "string",
        "phone": "string",
        "address": {
            "city": "string",
            "street": "string",
            "buildingNumber": "string",
            "ZIP": "string",
            "country": "string"
        },
        "company": {
            "address": {
                "city": "string",
                "street": "string",
                "buildingNumber": "string",
                "ZIP": "string",
                "country": "string"
            },
            "name": "string",
            "TIN": "string",
            "VATID": "string"
        },
        "clientPoints": 0,
        "dateOfBirth": "string",
        "reverseChargeEU": true,
        "note": "string"
    }
}

list

import