Sites

Physical sites a job runs at.

Licensed feature

This resource needs the construction feature active on the install you are calling. Without that every endpoint here answers 403 with feature_not_licensed - that is a licensing answer, not a permissions one, so check the company's features before the token's scopes.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
sitecode	string(20)	Short code of the site.
deal	text	Deal. Stored as `text`, no practical length limit.
owner	integer	0 when the site is not owned by the associated company.
location	string(250)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `locationid`, not both unless they agree.
estimate_groundbreak	string	Estimated groundbreaking date.
status	integer	Site status code.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
sitename	string(255)	Name of the site.
groundbreakingdate	string	Actual groundbreaking date.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/sites/batch 207

Create many.

Requires scope jobs:write.

Parameters

Name	In	Type	Notes
Idempotency-Key	header	string	Makes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers `409 idempotency_replay` rather than silently handing back the old response. Keys are remembered for 24 hours.

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
sitecode	string(20)	Short code of the site.
deal	text	Deal. Stored as `text`, no practical length limit.
owner	integer	0 when the site is not owned by the associated company.
location	string(250)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `locationid`, not both unless they agree.
estimate_groundbreak	string	Estimated groundbreaking date.
status	integer	Site status code.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
sitename	string(255)	Name of the site.
groundbreakingdate	string	Actual groundbreaking date.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/sites/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "sitecode": "ACME-01",
        "deal": "Example deal",
        "owner": 1,
        "location": "Example location",
        "estimate_groundbreak": "2026-08-01",
        "status": 1
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/sites/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'sitecode' => 'ACME-01',
      'deal' => 'Example deal',
      'owner' => 1,
      'location' => 'Example location',
      'estimate_groundbreak' => '2026-08-01',
      'status' => 1,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/sites/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "sitecode": "ACME-01",
            "deal": "Example deal",
            "owner": 1,
            "location": "Example location",
            "estimate_groundbreak": "2026-08-01",
            "status": 1,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/sites/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        sitecode: "ACME-01",
        deal: "Example deal",
        owner: 1,
        location: "Example location",
        estimate_groundbreak: "2026-08-01",
        status: 1,
      },
    ]),
  }
);
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 {
        sitecode = "ACME-01",
        deal = "Example deal",
        owner = 1,
        location = "Example location",
        estimate_groundbreak = "2026-08-01",
        status = 1,
    },
};

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

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

GET/sites 200403

List sites.

Requires scope jobs:read.

Parameters

Name	In	Type	Notes
status	query	string	Restrict to one status.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
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/sites' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/sites 201400

Create.

Requires scope jobs:write.

Parameters

Name	In	Type	Notes
Idempotency-Key	header	string	Makes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers `409 idempotency_replay` rather than silently handing back the old response. Keys are remembered for 24 hours.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
sitecode	string(20)	Short code of the site.
deal	text	Deal. Stored as `text`, no practical length limit.
owner	integer	0 when the site is not owned by the associated company.
location	string(250)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `locationid`, not both unless they agree.
estimate_groundbreak	string	Estimated groundbreaking date.
status	integer	Site status code.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
sitename	string(255)	Name of the site.
groundbreakingdate	string	Actual groundbreaking date.
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/sites' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "sitecode": "ACME-01",
    "deal": "Example deal",
    "owner": 1,
    "location": "Example location",
    "estimate_groundbreak": "2026-08-01",
    "status": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/sites');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'sitecode' => 'ACME-01',
    'deal' => 'Example deal',
    'owner' => 1,
    'location' => 'Example location',
    'estimate_groundbreak' => '2026-08-01',
    'status' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/sites",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "sitecode": "ACME-01",
        "deal": "Example deal",
        "owner": 1,
        "location": "Example location",
        "estimate_groundbreak": "2026-08-01",
        "status": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/sites',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      sitecode: "ACME-01",
      deal: "Example deal",
      owner: 1,
      location: "Example location",
      estimate_groundbreak: "2026-08-01",
      status: 1,
    }),
  }
);
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 {
    sitecode = "ACME-01",
    deal = "Example deal",
    owner = 1,
    location = "Example location",
    estimate_groundbreak = "2026-08-01",
    status = 1,
};

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

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

Response 201

{
    "sitecode": "ACME-01",
    "deal": "Example deal",
    "owner": 1,
    "location": "Example location",
    "estimate_groundbreak": "2026-08-01",
    "status": 1
}

GET/sites/{id} 200404

Retrieve one record.

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

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

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

Response 200

{
    "sitecode": "ACME-01",
    "deal": "Example deal",
    "owner": 1,
    "location": "Example location",
    "estimate_groundbreak": "2026-08-01",
    "status": 1
}

PATCH/sites/{id} 200404

Update.

Requires scope jobs:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
Idempotency-Key	header	string	Makes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers `409 idempotency_replay` rather than silently handing back the old response. Keys are remembered for 24 hours.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
sitecode	string(20)	Short code of the site.
deal	text	Deal. Stored as `text`, no practical length limit.
owner	integer	0 when the site is not owned by the associated company.
location	string(250)	The `locationcode` of the referenced inventorylocations, instead of the id. Send this or `locationid`, not both unless they agree.
estimate_groundbreak	string	Estimated groundbreaking date.
status	integer	Site status code.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
sitename	string(255)	Name of the site.
groundbreakingdate	string	Actual groundbreaking date.
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/sites/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "sitecode": "ACME-01",
    "deal": "Example deal",
    "owner": 1,
    "location": "Example location",
    "estimate_groundbreak": "2026-08-01",
    "status": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/sites/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'sitecode' => 'ACME-01',
    'deal' => 'Example deal',
    'owner' => 1,
    'location' => 'Example location',
    'estimate_groundbreak' => '2026-08-01',
    'status' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/sites/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "sitecode": "ACME-01",
        "deal": "Example deal",
        "owner": 1,
        "location": "Example location",
        "estimate_groundbreak": "2026-08-01",
        "status": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/sites/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      sitecode: "ACME-01",
      deal: "Example deal",
      owner: 1,
      location: "Example location",
      estimate_groundbreak: "2026-08-01",
      status: 1,
    }),
  }
);
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 {
    sitecode = "ACME-01",
    deal = "Example deal",
    owner = 1,
    location = "Example location",
    estimate_groundbreak = "2026-08-01",
    status = 1,
};

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

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

Response 200

{
    "sitecode": "ACME-01",
    "deal": "Example deal",
    "owner": 1,
    "location": "Example location",
    "estimate_groundbreak": "2026-08-01",
    "status": 1
}

DELETE/sites/{id} 200404

Cancel.

Requires scope jobs:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
Idempotency-Key	header	string	Makes the write safely retryable. Any unique string per logical operation; a UUID is fine. The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing. The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers `409 idempotency_replay` rather than silently handing back the old response. Keys are remembered for 24 hours.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/sites/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/sites/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.delete(
    "https://acme.nolapro.com/!/api/v2/sites/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/sites/104',
  {
    method: 'DELETE',
    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 req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/sites/104");

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

Response 200

{
    "sitecode": "ACME-01",
    "deal": "Example deal",
    "owner": 1,
    "location": "Example location",
    "estimate_groundbreak": "2026-08-01",
    "status": 1
}

Estimating quotes →

Quotes from the Estimating module. A different thing from an AR quote, which is an order with status quote - see the orders resource. ordertype 2 is a rental order, not a quote.

Quote price lists →

Price lists used by Estimating quotes. The wider Estimating configuration surface (about 40 tables) is a module pass of its own and is not exposed here.