Authorization
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
Some endpoints use keyset pagination, returning a limited number of results per response. The pagination information is included in both the HTTP headers and the response body.
Paginated responses included:
HTTP headers:
X-Has-Next-Page: true if more results are available
X-Per-Page: number of results per page (currently fixed at 5)
A pagination object in the JSON body:
{
"pageSize": 5,
"next": "00000000-0000-0000-000000000005"
}To retrieve the next page, use the next query parameter with the provided ID.
See the full pagination guide for more information.
Base URL for API
AUS/NZ: https://app.visibuild.com.au
Example API endpoint: https://app.visibuild.com.au/api/v2/projects/
Endpoints
For the full list of available endpoints with examples, see: