Get client

Clients can be retrieved by uuid or external_id.

Organizations and individuals have different sets of fields, see the table below.
Get organization using uuid
$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/clients/50c773b3-a4f8-5619-be47-cb6a0edb22cc | jq
{
  "client": {
    "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"
      }
    ],
    "version": 1
  }
}
Get organization using external_id
$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/clients/423430387320568-acme | jq
{
  "client": {
    "uuid": "50c773b3-a4f8-5619-be47-cb6a0edb22cc",
    "external_id": "423430387320568-acme",
    "name": "ACME Corporation",
    ...
  }
}
Get individual using uuid
$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/clients/b2584e3c-25dd-4773-ab8b-0a018fd58d2b | jq
{
  "client": {
    "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"
      }
    ]
  }
}
Table 1. Fields of client elements
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

Client name. This is either organization_name
or concatenation of first_name, last_name,
and middle_name values

organization_name*

String

String

No

Organization name. Limited to 5000 characters, some organizations have very long names

organization

Boolean

Boolean

No

Whether the client is an organization

first_name**

String

String

Yes

First name

last_name**

String

String

Yes

Last name

middle_name**

String

String

Yes

Middle name

contacts

[Contact]

Array

No

List of site contacts

site_address

Address

Object

Yes

Site address

version

Integer

Number

No

Version

* These fields are only present when organization is true

** These fields are only present when organization is false