--- updatedAt: 2026-05-28T20:32:37.000Z agentTools: projectIndex: https://docs.salussafety.io/llms.txt --- # Create a Project Create a project. This creates a project and automatically adds company owners as users to that project. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "SALUS Developer API", "version": "0.11.69" }, "servers": [ { "url": "https://developer.beta.salussafety.io" } ], "paths": { "/v1/project/": { "post": { "tags": [ "Projects" ], "summary": "Create a Project", "description": "Create a project.\n\nThis creates a project and automatically adds company owners as users to that project.", "operationId": "create_project_v1_project__post", "security": [ { "HTTPBearer": [] }, { "OAuth2ClientCredentialsBearer": [] }, { "OAuth2AuthorizationCodeBearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreateModel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiGenericResponse_UnifiedProjectDetailModel_" } } } }, "400": { "description": "Business Logic Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiGenericResponse_ErrorDetail_" } } } }, "403": { "description": "Permission Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiGenericResponse_ErrorDetail_" } } } }, "409": { "description": "Integrity Error or Data Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiGenericResponse_ErrorDetail_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "ApiGenericResponse_ErrorDetail_": { "properties": { "error": { "type": "boolean", "title": "Error Indicator", "description": "A boolean error indicator.", "default": false }, "message": { "title": "Response Message", "description": "Optional message.", "type": "string", "nullable": true }, "data": { "title": "Response Data", "description": "The response data for any given request.", "$ref": "#/components/schemas/ErrorDetail", "nullable": true } }, "type": "object", "title": "ApiGenericResponse[ErrorDetail]" }, "ApiGenericResponse_UnifiedProjectDetailModel_": { "properties": { "error": { "type": "boolean", "title": "Error Indicator", "description": "A boolean error indicator.", "default": false }, "message": { "title": "Response Message", "description": "Optional message.", "type": "string", "nullable": true }, "data": { "title": "Response Data", "description": "The response data for any given request.", "$ref": "#/components/schemas/UnifiedProjectDetailModel", "nullable": true } }, "type": "object", "title": "ApiGenericResponse[UnifiedProjectDetailModel]" }, "ErrorDetail": { "properties": { "requestPath": { "title": "Request Path", "description": "The path of the request that generated the error.", "type": "string", "nullable": true }, "requestMethod": { "title": "Request HTTP Method", "description": "The HTTP method of the request that generated the error.", "type": "string", "nullable": true }, "errorType": { "type": "string", "title": "The Error Type that Occurred", "description": "The type of error that occurred, broadly it can be 'Database', 'BusinessLogic', or 'Permissions`" }, "errorTypeDetail": { "title": "Errortypedetail", "description": "If available, an additional categorization of the error that occurred.", "type": "string", "nullable": true }, "errorDetail": { "title": "Errordetail", "type": "string", "nullable": true } }, "type": "object", "required": [ "errorType" ], "title": "ErrorDetail", "description": "Generic error detail object that the API will return where errors are encountered. Details will be extracted to\nmake error processing more straight forward." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "ProjectCompanyDetailsModel": { "properties": { "externalId": { "title": "External System Identifier", "description": "The unique identifier used by an external system, can be used to support integration.", "examples": [ "100123" ], "type": "string", "nullable": true }, "externalSystemName": { "title": "External System Name", "description": "The name of the external system that the external_id field belongs to.", "examples": [ "Procore" ], "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "title": "Is Archived", "description": "Indicates that a project has been archived for this company.", "examples": [ false ] }, "udf1": { "title": "User Defined Field 1", "description": "Field for storing customer-defined metadata about the site", "examples": [ "Canada Division" ], "type": "string", "nullable": true }, "udf2": { "title": "User Defined Field 2", "description": "Field for storing customer-defined metadata about the site", "examples": [ "BC Division" ], "type": "string", "nullable": true }, "udf3": { "title": "User Defined Field 3", "description": "Field for storing customer-defined metadata about the site", "examples": [ "Eli's team" ], "type": "string", "nullable": true }, "displayName": { "title": "Display Name", "description": "The display name for a project that can be customized per company working on a project.", "examples": [ "Company Prefix - Project Name" ], "type": "string", "nullable": true }, "accountingName": { "title": "Accounting System Name", "description": "The project name as it's represented in the accounting or financial system, in case it's different from the main project name.", "examples": [ "ACCT-SYS-01-PRJ-NAME" ], "type": "string", "nullable": true }, "jobNumber": { "title": "Job Number", "description": "Optional specifier for an external project number.", "examples": [ "001-PRJ-NAME" ], "type": "string", "nullable": true }, "siteClass": { "title": "Site Class", "description": "The project site class.", "examples": [ "Site Class" ], "type": "string", "nullable": true }, "description": { "title": "Description", "type": "string", "nullable": true }, "nearestHospital": { "title": "Nearest Hospital", "description": "Name of the nearest hospital to the site", "examples": [ "Vancouver General Hospital" ], "type": "string", "nullable": true }, "nearestClinic": { "title": "Nearest Clinic", "description": "Name of the nearest medical clinic to the site", "examples": [ "Alberni Medical Clinic" ], "type": "string", "nullable": true }, "firstAidAttendant": { "title": "First Aid Attendant", "description": "Name of the first aid attendant for the site", "examples": [ "Jane Doe" ], "type": "string", "nullable": true }, "siteLinkOne": { "title": "Site link 1", "description": "Any additional links for the site", "examples": [ "https://example.com" ], "type": "string", "nullable": true }, "siteLinkTwo": { "title": "Site link 2", "description": "Any additional links for the site", "examples": [ "https://example.com" ], "type": "string", "nullable": true }, "siteLinkThree": { "title": "Site link 3", "description": "Any additional links for the site", "examples": [ "https://example.com" ], "type": "string", "nullable": true }, "udf1Label": { "title": "Label for User Defined Field 1", "description": "Label for the customer-defined metadata about the site", "examples": [ "Division" ], "type": "string", "nullable": true }, "udf2Label": { "title": "Label for User Defined Field 2", "description": "Label for the customer-defined metadata about the site", "examples": [ "Subdivision" ], "type": "string", "nullable": true }, "udf3Label": { "title": "Label for User Defined Field 3", "description": "Label for the customer-defined metadata about the site", "examples": [ "Team" ], "type": "string", "nullable": true } }, "type": "object", "required": [ "externalId", "externalSystemName", "isArchived", "displayName", "accountingName", "jobNumber", "siteClass", "description", "nearestHospital", "nearestClinic", "firstAidAttendant", "siteLinkOne", "siteLinkTwo", "siteLinkThree" ], "title": "ProjectCompanyDetailsModel", "description": "Full version of company-specific project details" }, "ProjectCompanyPatchModel": { "properties": { "externalId": { "title": "External System Identifier", "description": "The unique identifier used by an external system, can be used to support integration.", "examples": [ "100123" ], "type": "string", "nullable": true }, "externalSystemName": { "title": "External System Name", "description": "The name of the external system that the external_id field belongs to.", "examples": [ "Procore" ], "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "title": "Is Archived", "description": "Indicates if the company wants to archive the site.", "default": false }, "displayName": { "title": "Display Name", "description": "The display name for a project that can be customized per company working on a project.", "examples": [ "Company Prefix - Project Name" ], "type": "string", "nullable": true }, "accountingName": { "title": "Accounting System Name", "description": "The project name as it's represented in the accounting or financial system, in case it's different from the main project name.", "examples": [ "ACCT-SYS-01-PRJ-NAME" ], "type": "string", "nullable": true }, "jobNumber": { "title": "Job Number", "description": "Optional specifier for an external project number.", "examples": [ "001-PRJ-NAME" ], "type": "string", "nullable": true }, "siteClass": { "title": "Site Class", "description": "The project site class.", "examples": [ "Site Class" ], "type": "string", "nullable": true }, "description": { "title": "Description", "type": "string", "nullable": true }, "nearestHospital": { "title": "Nearest Hospital", "description": "Name of the nearest hospital to the site", "examples": [ "Vancouver General Hospital" ], "type": "string", "nullable": true }, "nearestClinic": { "title": "Nearest Clinic", "description": "Name of the nearest medical clinic to the site", "examples": [ "Alberni Medical Clinic" ], "type": "string", "nullable": true }, "firstAidAttendant": { "title": "First Aid Attendant", "description": "Name of the first aid attendant for the site", "examples": [ "Jane Doe" ], "type": "string", "nullable": true }, "siteLinkOne": { "title": "Site link 1", "description": "Any additional links for the site", "examples": [ "https://example.com" ], "type": "string", "nullable": true }, "siteLinkTwo": { "title": "Site link 2", "description": "Any additional links for the site", "examples": [ "https://example.com" ], "type": "string", "nullable": true }, "siteLinkThree": { "title": "Site link 3", "description": "Any additional links for the site", "examples": [ "https://example.com" ], "type": "string", "nullable": true }, "udf1": { "title": "User Defined Field 1", "description": "Field for storing customer-defined metadata about the site", "examples": [ "Canada Division" ], "type": "string", "nullable": true }, "udf2": { "title": "User Defined Field 2", "description": "Field for storing customer-defined metadata about the site", "examples": [ "BC Division" ], "type": "string", "nullable": true }, "udf3": { "title": "User Defined Field 3", "description": "Field for storing customer-defined metadata about the site", "examples": [ "Eli's team" ], "type": "string", "nullable": true } }, "type": "object", "title": "ProjectCompanyPatchModel", "description": "Company specific project details that can optionally be updated" }, "ProjectCreateModel": { "properties": { "name": { "type": "string", "title": "Project Name", "description": "The name of the project.", "examples": [ "The Project Name" ] }, "address": { "type": "string", "title": "Address", "description": "The address of the project site.", "examples": [ "123 Somewhere Ave" ] }, "city": { "type": "string", "title": "City", "description": "The city of the project site.", "examples": [ "Vancouver" ] }, "country": { "type": "string", "title": "Country", "description": "The country of the project site.", "examples": [ "Canada" ] }, "timezone": { "type": "string", "title": "Timezone", "description": "The timezone associated with the project site.", "examples": [ "America/Vancouver" ] }, "phone": { "title": "Main Phone", "description": "The main phone number associated with the project site.", "examples": [ "16045551234" ], "type": "string", "nullable": true }, "longitude": { "title": "Longitude", "description": "The longitude of the project site.", "examples": [ 35.89421911 ], "type": "number", "nullable": true }, "latitude": { "title": "Latitude", "description": "The latitude of the project site.", "examples": [ 139.94637467 ], "type": "number", "nullable": true }, "musterPoint": { "title": "Muster Point", "description": "The muster point for the project site.", "type": "string", "nullable": true }, "isPrivate": { "type": "boolean", "title": "Is Private", "description": "Indicates that a project is private.", "default": true, "examples": [ true ] }, "geoCheckInEnabled": { "type": "boolean", "title": "Enable geo check-in", "description": "Enable or disable having workers get automatically checked in and out of the site based on their location", "default": true, "examples": [ true, false ] }, "companyProject": { "$ref": "#/components/schemas/ProjectCompanyPatchModel", "nullable": true } }, "type": "object", "required": [ "name", "address", "city", "country", "timezone", "companyProject" ], "title": "ProjectCreateModel", "description": "Model for creating a project. Includes info for both project and company-project" }, "UnifiedProjectDetailModel": { "properties": { "id": { "title": "Identifier", "description": "Unique internal project identifier.", "examples": [ 123 ], "type": "integer", "nullable": true }, "name": { "title": "Name", "description": "The project name.", "examples": [ "The Project Name" ], "type": "string", "nullable": true }, "address": { "title": "Address", "description": "The address of the project site.", "examples": [ "123 Somewhere Ave" ], "type": "string", "nullable": true }, "city": { "title": "City", "description": "The city of the project site.", "examples": [ "Vancouver" ], "type": "string", "nullable": true }, "country": { "title": "Country", "description": "The country of the project site.", "examples": [ "Canada" ], "type": "string", "nullable": true }, "timezone": { "title": "Timezone", "description": "The timezone associated with the project site.", "examples": [ "America/Vancouver" ], "type": "string", "nullable": true }, "phone": { "title": "Main Phone", "description": "The main phone number associated with the project site.", "examples": [ "16045551234" ], "type": "string", "nullable": true }, "longitude": { "title": "Longitude", "description": "The longitude of the project site.", "examples": [ 35.89421911 ], "type": "number", "nullable": true }, "latitude": { "title": "Latitude", "description": "The latitude of the project site.", "examples": [ 139.94637467 ], "type": "number", "nullable": true }, "siteCode": { "title": "Site Code", "description": "Unique 5 digit site code generated by the system.", "examples": [ 54231 ], "type": "integer", "nullable": true }, "musterPoint": { "title": "Muster Point", "description": "The muster point for the project site.", "type": "string", "nullable": true }, "isPrivate": { "title": "Is Private", "description": "Indicates that a project is private.", "examples": [ true ], "type": "boolean", "nullable": true }, "geoCheckInEnabled": { "type": "boolean", "title": "Enable geo check-in", "description": "Enable or disable having workers get automatically checked in and out of the site based on their location", "default": true, "examples": [ true, false ] }, "updatedAt": { "title": "Updated At", "description": "The time stamp of the last time the field was updated.", "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "title": "Created At", "description": "The time stamp when the record was created.", "type": "string", "format": "date-time", "nullable": true }, "companyProject": { "title": "Company Project info", "description": "Information for the project that can be different for each company on the project", "$ref": "#/components/schemas/ProjectCompanyDetailsModel", "nullable": true } }, "type": "object", "title": "UnifiedProjectDetailModel" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "HTTPBearer": { "type": "http", "description": "Used for authentication using the _classic_ authorization protocol flow, against the Core API. \n\n", "scheme": "bearer" }, "OAuth2ClientCredentialsBearer": { "type": "oauth2", "description": "Used for authentication using the _credentials_grant_ OAuth protocol flow.", "flows": { "clientCredentials": { "scopes": { "sls:idn": "Request Salus identity information." }, "tokenUrl": "https://guardian.beta.salussafety.io/token" } } }, "OAuth2AuthorizationCodeBearer": { "type": "oauth2", "description": "Used for authentication using the _authorization_code_ OAuth protocol flow.", "flows": { "authorizationCode": { "refreshUrl": "https://guardian.beta.salussafety.io/token", "scopes": { "sls:idn": "Request Salus identity information." }, "authorizationUrl": "https://guardian.beta.salussafety.io/authorize", "tokenUrl": "https://guardian.beta.salussafety.io/token" } } } } }, "tags": [ { "name": "Projects", "description": "\nEndpoints for interacting with projects\n\nProjects generally represent physical locations. In construction verticals they are commonly construction sites, and have a unique address. Generally the address is also translated to longitude and latitude coordinates to enable geofencing and other features related to the physical location of the site.\n" } ] } ```