Get user
Users can be retrieved by uuid
or email
.
uuid
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/users/c855dc30-11ce-4a64-98f9-4951d9fa2da7 | jq
{
"user": {
"uuid": "c855dc30-11ce-4a64-98f9-4951d9fa2da7",
"email": "john@doe",
"first_name": "John",
"last_name": "Doe",
"permissions": {
"web": {
"login": true,
"jobs": {
"view": true,
"edit": true,
"delete": true
},
"clients": {
"view": true,
"edit": true
},
"schedule": {
"view": true,
"edit": true
},
"map": {
"edit": false
},
"shifts": {
"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"
}
}
}
Field | Type | JSON Type | Can be null |
Description |
---|---|---|---|---|
|
UUID |
String |
No |
Unique identifier |
|
String |
String |
No |
User’s email address. |
|
String |
String |
No |
User first name |
|
String |
String |
No |
User last name |
|
Object |
No |
User permissions |
|
|
Boolean |
Boolean |
No |
Whether the user requires a license. |
|
Boolean |
Boolean |
No |
Whether the user is the owner of a Planado instance. |
|
String |
String |
Yes |
Mobile phone number |
|
[Skill] |
Array |
No |
List of skills |
|
Object |
Yes |
Default user territory |
email
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/users/john@doe | jq
{
"user": {
"uuid": "c855dc30-11ce-4a64-98f9-4951d9fa2da7",
"email": "john@doe",
...
}
}