Get site

Sites can be retrieved by uuid or external_id.

Using uuid
$ curl -H "Authorization: Bearer api-key" \
  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"
      }
    ],
    "territory": {
      "uuid": "137ecf60-06cd-6930-bd93-46513db41965",
      "name": "Barcelona"
    },
    "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,
    "created_at": "2016-05-29T17:31:01.419601Z",
    "updated_at": "2016-06-07T10:57:19.529209Z"
  }
}
Table 1. Fields of site
Field Type JSON type Can be null Description

uuid

UUID

String

No

Unique identifier

external_id

String

String

Yes

External ID

name

String

String

No

Site name. Up to 300 characters

description

String

String

Yes

Optional site description. Up to 1000 characters

contacts

[Contact]

Array

No

List of site contacts

territory

Territory

Object

No

Territory reference

address

Address

Object

Yes

Site address

client

Client

Object

Yes

Optional client reference

version

Integer

Number

No

Version

created_at

Timestamp

String

No

Timestamp of creation

updated_at

Timestamp

String

No

Timestamp of last update
Using external_id
$ curl -H "Authorization: Bearer api-key" 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",
    ...
  }
}