Список клиентов
Клиенты упорядочены от самых новых к самым старым.
Юрлица и физлица имеют различный набор полей, см. таблицу. |
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/clients | jq
{
"clients": [
{
"uuid": "50c773b3-a4f8-5619-be47-cb6a0edb22cc",
"external_id": "423430387320568-acme",
"name": "ACME Corporation",
"organization": true,
"organization_name": "ACME Corporation",
"site_address": {
"formatted": "Passeig de Gràcia, 92, 08008 Barcelona, Spain",
"entrance_no": "1",
"apartment": null,
"floor": "1",
"description": "Entrance via Carrer de Procença",
"geolocation": {
"longitude": 37.6785237278356,
"latitude": 55.7862807707096
}
},
"contacts": [
{
"name": "Pedro",
"value": "(834) 362-5246",
"type": "phone"
},
]
},
{
"uuid": "b2584e3c-25dd-4773-ab8b-0a018fd58d2b",
"external_id": "22451458596510-john-doe-the-second",
"name": "John Doe the Second",
"organization": false,
"first_name": "John",
"last_name": "Doe",
"middle_name": "the second",
"site_address": {
"formatted": "VFWH+25 Rome, Metropolitan City of Rome, Italy",
"entrance_no": "3",
"apartment": "11",
"floor": "2",
"description": "Knock hard",
"geolocation": {
"longitude": 12.4772501,
"latitude": 41.8950619
}
},
"contacts": [
{
"name": "John",
"value": "(923) 820-5063",
"type": "phone"
}
]
},
...
]
}
Поле | Тип | JSON-тип | Может быть null |
Описание |
---|---|---|---|---|
|
UUID |
Строка |
Нет |
Уникальный идентификатор |
|
Строка |
Строка |
Да |
|
|
Строка |
Строка |
Нет |
Имя клиента (это |
|
Строка |
Строка |
Нет |
Название организации. Ограничено 5000 символов |
|
Булев |
Булев |
Нет |
Является ли клиент юрлицом |
|
Строка |
Строка |
Да |
Имя |
|
Строка |
Строка |
Да |
Фамилия |
|
Строка |
Строка |
Да |
Отчество |
|
[Контакт] |
Массив |
Нет |
Список контактов |
|
Объект |
Да |
Адрес |
*
Эти поля присутствуют только для юрлиц (organization == true
)
**
Эти поля присутствуют только для физлиц (organization == false
)