Получение объекта

Объект может быть получен по uuid или external_id.

Используя uuid
$ curl -H "X-Planado-API-Key:XXX" \
  https://api.planadoapp.com/v2/sites/dc62cfdf-f9f1-59ec-80bd-ff5da151e515 | jq
{
  "site": {
    "uuid": "dc62cfdf-f9f1-59ec-80bd-ff5da151e515",
    "external_id": "kelheimer-6",
    "name": "RV Media Kelheimer Straße",
    "description": "RV Media",
    "contacts": [
      {
        "name": "Herr Karl",
        "value": "0179-1234567",
        "type": "phone"
      }
    ],
    "address": {
      "formatted": "Kelheimer Str. 6, 10777 Berlin, Germany",
      "entrance_no": null,
      "apartment": null,
      "floor": "3",
      "description": null,
      "geolocation": {
        "longitude": 13.3363265,
        "latitude": 52.4984896
      }
    },
    "client": {
      "uuid": "3945339f-97d2-5e51-8148-f38fe693695f",
      "external_id": "rv-media"
    },
    "version": 3
  }
}
Table 1. Поля site
Поле Тип JSON-тип Может быть null Описание

uuid

UUID

Строка

Нет

Уникальный идентификатор

external_id

Строка

Строка

Да

Внешний идентификатор

name

Строка

Строка

Нет

Название объекта. Ограничено 300 символами

description

Строка

Строка

Да

Описание объекта. Ограничено 1000 символов

contacts

[Контакт]

Массив

Нет

Список контактов

address

Адрес

Объект

Да

Адрес

client

Клиент

Объект

Да

Клиент

version

Целое

Число

Нет

Версия

Используя external_id
$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/sites/kelheimer-6 | jq
{
  "sites": {
    "uuid": "dc62cfdf-f9f1-59ec-80bd-ff5da151e515",
    "external_id": "kelheimer-6",
    "name": "RV Media Kelheimer Straße",
    "description": "RV Media",
    ...
  }
}