Users
Read-only, and deliberately minimal. Users are who NolaPro attributes work to, so an integrator needs to resolve an id to a name - and nothing more. Credentials, API keys, two-factor secrets and the ninety-odd preference columns are never returned.
The object#
| Field | Type | Description |
|---|---|---|
| idread-only | integer | User id. This is what entryuserid and friends hold. |
| nameread-only | string(50) | Login name. |
| firstnameread-only | string(35) | The user’s first name. |
| lastnameread-only | string(35) | The user’s last name. |
| emailread-only | string(100) | Email address. |
| supervisorread-only | boolean | Supervisor in this company. |
| cancelread-only | boolean | True once the user is cancelled. |
Endpoints#
GET/genusers
200403
List users.
Requires scope users:read.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| name | query | string | name. Partial match, case-insensitive. |
| cancel | query | string | Defaults to false. Pass true or any. |
| include | query | string | Comma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions. |
When it fails
| Status | Code | Meaning |
|---|---|---|
| 403 | insufficient_scope | Token lacks genusers:read. |
curl \ 'https://acme.nolapro.com/!/api/v2/genusers' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/genusers'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.get( "https://acme.nolapro.com/!/api/v2/genusers", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/genusers', { method: 'GET', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var res = await http.GetAsync( "https://acme.nolapro.com/!/api/v2/genusers"); res.EnsureSuccessStatusCode();
GET/genusers/{id}
200404
Retrieve one record.
Requires scope users:read.
Parameters
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The record id. |
| include | query | string | Comma-separated extras to embed. Only custom_fields is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions. |
When it fails
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No record with that id. |
curl \ 'https://acme.nolapro.com/!/api/v2/genusers/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/genusers/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.get( "https://acme.nolapro.com/!/api/v2/genusers/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/genusers/104', { method: 'GET', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, } ); const data = await res.json();
using System.Net.Http.Json; var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); var res = await http.GetAsync( "https://acme.nolapro.com/!/api/v2/genusers/104"); res.EnsureSuccessStatusCode();
Response 200
{
"id": 2,
"name": "jsmith",
"firstname": "Jane",
"lastname": "Smith",
"email": "jane@example.com",
"supervisor": false,
"cancel": false
}