List users

Users are ordered by creation date, from oldest to newest.

$ curl -H "X-Planado-API-Key:XXX" https://api.planadoapp.com/v2/users | jq
{
  "users": [
    {
      "uuid": "c855dc30-11ce-4a64-98f9-4951d9fa2da7",
      "email": "john@doe",
      "first_name": "John",
      "last_name": "Doe",
      "permissions": {
        "web": {
          "login": true,
          "jobs": {
            "view": true,
            "edit": true
          },
          "clients": {
            "view": true,
            "edit": true
          },
          "schedule": {
            "view": true,
            "edit": true
          },
          "map": {
            "view": false,
            "edit": false
          },
          "teams": {
            "view": true,
            "edit": true
          }
        },
        "mobile": {
          "login": true,
          "jobs": {
            "view": true,
            "complete": true
          }
        }
      },
      "uses_license": true,
      "owner": false,
      "mobile_phone": null,
      "skills": [
        {
          "uuid": "a1620b1d-257d-49a9-9adf-6e958603c571",
          "name": "Installation"
        },
        {
          "uuid": "ea2af535-33e6-4398-bf37-0fc3f1d0c7a2",
          "name": "Diagnostic"
        }
      ],
      "territory": {
        "uuid": "d9bb680b-c5d6-423e-b7b1-21e634f6fe3b",
        "name": "New York"
      }
    },
    ...
  ]
}
Table 1. Fields of users elements
Field Type JSON Type Can be null Description

uuid

UUID

String

No

Unique identifier

email

String

String

No

User’s email address.
This is a globally unique value

fist_name

String

String

No

User first name

last_name

String

String

No

User last name

permissions

Record

Object

No

User permissions

uses_license

Boolean

Boolean

No

Whether the user requires a license.
It is a computed value based on user’s permissions

owner

Boolean

Boolean

No

Whether the user is the owner of a Planado instance.
This value cannot be modified via API but ownership can be transferred in settings

mobile_phone

String

String

Yes

Mobile phone number

skills

[Skill]

Array

No

List of skills

territory

Territory

Object

Yes

Default user territory