All endpoints expect an Authorization header in the following format:
Authorization: Bearer <your token here>
Refer to the token generation documentation if you are unsure how to generate a token.
Shared data types
ID
IDs are universally unique and do not change over time. They follow a UUID layout and are represented as strings in the API.
As an example: 01954998-d842-c56c-cc9f-599ec52c475c
ShallowVisiCounts
A JSON object representing the counts of Visis grouped by their statuses.
There are 8 keys for each ShallowVisiCounts type: the 6 statuses plus complete and total. complete is always the sum of na, cantClose, and closed and provided for convenience. total will always be the sum of all 6 statuses.
Schema
{
open: number,
inProgress: number,
inReview: number,
na: number,
cantClose: number,
closed: number,
complete: number,
total: number
}
VisiCounts
A two layered JSON object representing the counts of Visis grouped by their types and statuses.
Schema
{
inspection?: ShallowVisiCounts,
task?: ShallowVisiCounts,
incorrectWorks?: ShallowVisiCounts,
ncr?: ShallowVisiCounts,
defect?: ShallowVisiCounts,
incompleteWorks?: ShallowVisiCounts,
holdPoint?: ShallowVisiCounts,
witnessPoint?: ShallowVisiCounts
}
Pagination
Contains information about the page size and next page's info. See pagination for more information.
Schema
{
pageSize: number,
next: ID
}
Endpoints
GET /api/v2/projects
Returns basic information on all active projects, including IDs and names.
Schema
{
data: {
projects: Array<
{
id: ID,
name: string
}
>
}
}Example response
{
"data": {
"projects": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Example Project"
},
{
"id": "00000000-0000-0000-000000000001",
"name": "Example Project 2"
}
]
}
}
GET /api/v2/projects/visi-counts
Returns a paginated list of projects with Visi counts grouped by type and status.
skippedHoldPoints counts the number of hold points across the entire project that have been skipped. That is, hold points that originated in a template that were still incomplete when a Visi that occurs after it in the template was completed. For example:
Schema
{
data: {
projects: Array<
{
id: ID,
name: string,
visiCounts: VisiCounts,
skippedHoldPoints: number
}
>
},
pagination: Pagination
}Example response
{
"data": {
"projects": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Example Project",
"visiCounts": {
"inspection": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"task": {...},
"incorrectWorks": {...},
"ncr": {...},
"defect": {...},
"incompleteWorks": {...},
"holdPoint": {...},
"witnessPoint": {...}
},
"skippedHoldPoints": 0
},
... (4 more projects)
]
},
"pagination": {
"pageSize": 5,
"next": "00000000-0000-0000-000000000005"
}
}
Fetch the next page by appending ?next=<id> to the URL. Refer to the pagination documentation for more information.
GET /api/v2/projects/:projectId/companies
Returns the companies on a project and their business number (if set). The company's business number will typically be the ABN of the business (for Australian businesses), and the equivalent for other regions.
Schema
{
data: {
companies: Array<
{
id: ID,
name: string,
active: boolean,
projectOwner: boolean,
businessNumber: string | null
}
>
}
}Example response
{
"data": {
"companies": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Company 1",
"active": true,
"projectOwner": true,
"businessNumber": "00012345678"
},
{
"id": "00000000-0000-0000-000000000001",
"name": "Company 2",
"active": true,
"projectOwner": false,
"businessNumber": null
}
]
}
}
GET /api/v2/projects/:projectId/visi-counts-by-assignee
Returns the Visi counts on a project grouped by the company (or company of the member, if assigned to a member) each Visi is assigned to.
Schema
{
data: {
companies: Array<
{
id: ID,
name: string,
visiCounts: VisiCounts
}
>
}
}Example response
{
"data": {
"companies": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Company 1",
"visiCounts": {
"inspection": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"task": {...},
"incorrectWorks": {...},
"ncr": {...},
"defect": {...},
"incompleteWorks": {...},
"holdPoint": {...},
"witnessPoint": {...}
}
},
{
"id": "00000000-0000-0000-000000000000",
"name": "Company 2",
"visiCounts": {
"inspection": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
},
"task": {...},
"incorrectWorks": {...},
"ncr": {...},
"defect": {...},
"incompleteWorks": {...},
"holdPoint": {...},
"witnessPoint": {...}
}
}
]
}
}
GET /api/v2/projects/:projectId/visi-counts-by-tags
Returns the Visi counts on a project grouped by tags that are on each Visi.
Note: The same Visi may be counted multiple times under each key. For example, a task with tags "Services" and "Electrical" will be counted twice, once under stages and once under disciplines.
Schema
{
"data": {
"stage": Array<
{
"id": ID,
"name": string,
"visiCounts": VisiCounts
}
>
}
}Example response
{
"data": {
"stages": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Services",
"visiCounts": {
"inspection": {
"open": 10,
"inProgress": 5,
"inReview": 2,
"closed": 4,
"na": 0,
"cantClose": 3,
"complete": 4,
"total": 26
},
"task": {...},
"incorrectWorks": {...},
"ncr": {...},
"defect": {...},
"incompleteWorks": {...},
"holdPoint": {...},
"witnessPoint": {...}
}
}
],
"disciplines": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Electrical",
"visiCounts": {
"inspection": {
"open": 10,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 10
},
"task": {...},
"incorrectWorks": {...},
"ncr": {...},
"defect": {...},
"incompleteWorks": {...},
"holdPoint": {...},
"witnessPoint": {...}
}
}
]
}
}
GET /api/v2/projects/:projectId/template-completion
Returns a paginated list of project templates and their deployment and completion counts for a project. total counts the total number of times the template is created across the projects, counting all revisions of the template. complete counts the number of those templates which have been closed, marked as N/A, or marked as can't close.
Schema
{
data: {
templates: Array<
{
id: ID,
title: string,
owningCompanyId: ID,
deployments: {
total: number,
complete: number
}
}
>
},
pagination: Pagination
}Example response
{
"data": {
"templates": [
{
"id": "00000000-0000-0000-000000000000",
"title": "Concrete pour",
"owningCompanyId": "00000000-0000-0000-000000000000",
"deployments": {
"total": 123,
"complete": 45
},
{
"id": "00000000-0000-0000-000000000000",
"title": "Balcony waterproofing",
"owningCompanyId": "00000000-0000-0000-000000000000",
"deployments": {
"total": 0,
"complete": 0
}
]
},
"pagination": {
"pageSize": number,
"next": "00000000-0000-0000-000000000005"
}
}
GET /api/v2/projects/:projectId/locations
Returns complete list of all locations in a given project. :projectId matches the id keys corresponding to projects in other endpoints. Consider the following project structure:
order is an integer that represents where the location is ordered relative to its siblings.
parentLocationId will always be null for the root location; all other locations should have a parent.
childLocationIds is a flat array of the IDs of immediate child locations.
pathName is a serialised string representing the location and all ancestor locations up to the root, delimited by / .
Schema
{
data: {
locations: Array<
{
id: ID,
name: string,
order: number,
parentLocationId: ID | null,
childLocationIds: Array<ID>,
pathName: string
}
>
}
}Example response
{
"data": {
"locations": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Project",
"order": 1,
"parentLocationId": null,
"childLocationIds": [
"00000000-0000-0000-000000000001"
],
"pathName": "Project"
},
{
"id": "00000000-0000-0000-000000000001",
"name": "Area 1",
"order": 1,
"parentLocationId": "00000000-0000-0000-000000000000"
"childLocationIds": [
"00000000-0000-0000-000000000002",
"00000000-0000-0000-000000000003"
],
"pathName": "Project / Area 1"
},
{
"id": "00000000-0000-0000-000000000002",
"name": "Silo 1",
"order": 1,
"parentLocationId": "00000000-0000-0000-000000000001",
"childLocationIds": [],
"pathName": "Project / Area 1 / Silo 1"
},
{
"id": "00000000-0000-0000-000000000003",
"name": "Silo 2",
"order": 2,
"parentLocationId": "00000000-0000-0000-000000000001",
"childLocationIds": [],
"pathName": "Project / Area 1 / Silo 2"
}
]
}
}
GET /api/v2/projects/:projectId/locations/:locationId/visi-counts
Returns same information as :projectId/locations plus Visi status counts. The difference is that you only get the requested location and immediate children.
Schema
{
data: {
locations: Array<
{
id: ID,
name: string,
order: number,
parentLocationId: ID | null,
childLocationIds: Array<ID>,
pathName: string,
visiCounts: ShallowVisiCounts
}
>
}
}Example response
{
"data": {
"locations": [
{
"id": "00000000-0000-0000-000000000000",
"name": "Project",
"order": 1,
"parentLocationId": null,
"childLocationIds": [
"00000000-0000-0000-000000000001"
],
"pathName": "Project",
"visiCounts": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
}
},
{
"id": "00000000-0000-0000-000000000001",
"name": "Area 1",
"order": 1,
"parentLocationId": "00000000-0000-0000-000000000000",
"childLocationIds": [
"00000000-0000-0000-000000000002",
"00000000-0000-0000-000000000003"
],
"pathName": "Project / Area 1",
"visiCounts": {
"open": 0,
"inProgress": 0,
"inReview": 0,
"closed": 0,
"na": 0,
"cantClose": 0,
"complete": 0,
"total": 0
}
}
]
}
}
GET /api/v2/projects/:projectId/active-user-counts
Returns a count of all unique active users on a project for a date range (inclusive) per company you have access to. Dates and companies with no active users are excluded from the response.
Params
from: Date, required: true
to: Date, required: true
Note: Active user counts for today's date are not available. In other words, to must be yesterday or earlier.
Example endpoint
/api/v2/projects/00000000-0000-0000-0000-000000000000/active-user-counts?from=2025-01-01&to=2025-01-03
Schema
{
data: {
activeUserCounts: Array<
{
date: ID,
count: number,
companyId: ID
}
>
}
}Example response
{
"data": {
"activeUserCounts": [
{
"date": "2025-02-07",
"count": 5,
"companyId": "00000000-0000-0000-0000-000000000001"
},
{
"date": "2025-02-01",
"count": 3,
"companyId": "00000000-0000-0000-0000-000000000002"
},
{
"date": "2025-02-03",
"count": 2,
"companyId": "00000000-0000-0000-0000-000000000002"
}
]
}
}