Project settings

Module settings, key/value.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
settingkey	string(50)	Name of the setting (unique per project).
settingvalue	string(255)	Value stored for the setting.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/teamprojectsettings/batch 207

Create many.

Requires scope projects:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
settingkey	string(50)	Name of the setting (unique per project).
settingvalue	string(255)	Value stored for the setting.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "settingkey": "Example settingkey",
        "settingvalue": "Example settingvalue"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectsettings/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'settingkey' => 'Example settingkey',
      'settingvalue' => 'Example settingvalue',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/teamprojectsettings/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "settingkey": "Example settingkey",
            "settingvalue": "Example settingvalue",
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        settingkey: "Example settingkey",
        settingvalue: "Example settingvalue",
      },
    ]),
  }
);
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 body = new[] {
    new {
        settingkey = "Example settingkey",
        settingvalue = "Example settingvalue",
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/teamprojectsettings/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/teamprojectsettings 200403

List project settings.

Requires scope projects:read.

Parameters

Name	In	Type	Notes
modifiedsince	query	string	RFC 3339 UTC timestamp. Returns only records changed since then, including cancelled ones - so `cancel` defaults to any rather than `false` when this is used. The response carries `_meta.synced_through`; store it and send it back next time.
externalid	query	string	Exact match on your own key.
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 read scope.

curl \
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectsettings');
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/teamprojectsettings",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings',
  {
    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/teamprojectsettings");
res.EnsureSuccessStatusCode();

POST/teamprojectsettings 201400

Create.

Requires scope projects:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
settingkey	string(50)	Name of the setting (unique per project).
settingvalue	string(255)	Value stored for the setting.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "settingkey": "Example settingkey",
    "settingvalue": "Example settingvalue"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectsettings');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'settingkey' => 'Example settingkey',
    'settingvalue' => 'Example settingvalue',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/teamprojectsettings",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "settingkey": "Example settingkey",
        "settingvalue": "Example settingvalue",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      settingkey: "Example settingkey",
      settingvalue: "Example settingvalue",
    }),
  }
);
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 body = new {
    settingkey = "Example settingkey",
    settingvalue = "Example settingvalue",
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/teamprojectsettings") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 201

{
    "settingkey": "Example settingkey",
    "settingvalue": "Example settingvalue"
}

GET/teamprojectsettings/{id} 200404

Retrieve one record.

Requires scope projects: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/teamprojectsettings/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectsettings/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/teamprojectsettings/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings/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/teamprojectsettings/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "settingkey": "Example settingkey",
    "settingvalue": "Example settingvalue"
}

PATCH/teamprojectsettings/{id} 200404

Update.

Requires scope projects:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
settingkey	string(50)	Name of the setting (unique per project).
settingvalue	string(255)	Value stored for the setting.
entrydateread-only	string	When the record was created.
lastchangedateread-only	string	Last modification. Drives `modifiedsince`.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "settingkey": "Example settingkey",
    "settingvalue": "Example settingvalue"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/teamprojectsettings/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'settingkey' => 'Example settingkey',
    'settingvalue' => 'Example settingvalue',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/teamprojectsettings/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "settingkey": "Example settingkey",
        "settingvalue": "Example settingvalue",
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/teamprojectsettings/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      settingkey: "Example settingkey",
      settingvalue: "Example settingvalue",
    }),
  }
);
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 body = new {
    settingkey = "Example settingkey",
    settingvalue = "Example settingvalue",
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/teamprojectsettings/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "settingkey": "Example settingkey",
    "settingvalue": "Example settingvalue"
}

Task activity →

Read-only. Auto-logged change history. Written by the application, never by a caller.

Buildings →

Buildings that rentable units belong to.