clients

Klienci

GET '/list/{listId}/clients'

geting clients list, option GET parameters

• page: page number
• q: search query

{
    "status": "ok",
    "count": "2",
    "data": [
        {
            "id": 90,
            "categories": [],
            "tags": [],
            "name": "Client name",
            "name_more": "Description",
            "street": "Street",
            "postal_code": "code",
            "city": "city",
            "phone": "+48 12 345 67 89",
            "email": "test@test.pl",
            "createdAt": {
                "date": "2016-05-30 14:30:39",
                "timezone_type": 3,
                "timezone": "Europe/Berlin"
            },
            "customFields": [
                {
                    "id": 13,
                    "name": "Custom field 1",
                    "value": ""
                },
                {
                    "id": 14,
                    "name": "Custom field 2",
                    "value": ""
                },
                {
                    "id": 15,
                    "name": "Custom field 3",
                    "value": ""
                }
            ]
        },
        {
            "id": 89,
            "categories": [],
            "tags": [],
            "name": "Test",
            "name_more": null,
            "street": null,
            "postal_code": null,
            "city": null,
            "phone": null,
            "email": null,
            "createdAt": {
                "date": "2016-05-30 14:05:33",
                "timezone_type": 3,
                "timezone": "Europe/Berlin"
            },
            "customFields": [
                {
                    "id": 13,
                    "name": "Custom field 1",
                    "value": ""
                },
                {
                    "id": 14,
                    "name": "Custom field 2",
                    "value": ""
                },
                {
                    "id": 15,
                    "name": "Custom field 3",
                    "value": ""
                }
            ]
        }
    ]
}

GET '/list/{listId}/clients/{clientId}'

get client data:

{
    "status": "ok",
    "data": {
        "id": 90,
        "categories": [],
        "tags": [],
        "name": "Client name 123",
        "name_more": "Description",
        "street": "Street",
        "postal_code": "code",
        "city": "city",
        "phone": "+48 12 345 67 89",
        "email": "test@test.pl",
        "createdAt": {
            "date": "2016-05-30 14:30:39",
            "timezone_type": 3,
            "timezone": "Europe/Berlin"
        },
        "customFields": [
            {
                "id": 13,
                "name": "Custom field 1",
                "value": ""
            },
            {
                "id": 14,
                "name": "Custom field 2",
                "value": ""
            },
            {
                "id": 15,
                "name": "Custom field 3",
                "value": ""
            }
        ]
    }
}

POST '/list/{listId}/clients'

{
    "name": "Client name",
    "nameMore": "Description",
    "street": "Street",
    "postalCode": "code",
    "city": "city",
    "email": "test@test.pl",
    "phone": "+48123456789"
}

add client

{
    "status": "ok",
    "data": {
        "id": 90,
        "name": "Client name",
        "nameMore": "Description",
        "street": "Street",
        "postalCode": "code",
        "city": "city",
        "email": "test@test.pl",
        "phone": "+48 12 345 67 89",
        "tags": [],
        "categories": [],
        "customFields": []
    }
}

PUT '/list/{listId}/clients/{clientId}'

{
    "name": "Client name 123"
}

edit client:

{
    "status": "ok",
    "data": {
        "id": 90,
        "categories": [],
        "tags": [],
        "name": "Client name 123",
        "name_more": "Description",
        "street": "Street",
        "postal_code": "code",
        "city": "city",
        "phone": "+48 12 345 67 89",
        "email": "test@test.pl",
        "createdAt": {
            "date": "2016-05-30 14:30:39",
            "timezone_type": 3,
            "timezone": "Europe/Berlin"
        },
        "customFields": [
            {
                "id": 13,
                "name": "Custom field 1",
                "value": ""
            },
            {
                "id": 14,
                "name": "Custom field 2",
                "value": ""
            },
            {
                "id": 15,
                "name": "Custom field 3",
                "value": ""
            }
        ]
    }
}

DELETE '/list/{listId}/clients/{clientId}'

delete client:

{
    "status": "ok"
}