Sign in

v1

latestOpenAPI 3.1.02026-07-2466150275.0 KB
Public URLs

Create Bundle URL

Create a public access URL for a bundle of items, including forms, assets, documents, and a site check-in.

The following set of "public_access_item" types are supported:

  • "form", "id" - this is the ID of the form template
  • "document", "id" - this is the ID of the specific document
  • "asset", "id" - this is the ID of the asset
  • "title", "url" - for a link; we have to specify the title and URL
  • "on_site_log" - for the on_site_log the site has to be specified

This generates a link that will encode the bundle.

post/v1/public-access/bundle/

Request body

namestring required

A name that will be used when a user navigates to the URL of the bundle

siteIdinteger required

This is the ID of the site that will automatically be associated with time in this bundle.

allowUserJoinCompanyboolean

If this is true, users will be propmted to join your company once they scan the QR code, only if they are not already associated with a company

allowSubcontractorboolean

If this is true, companies subcontracting on the selected site can access the forms

allowUserJoinSubcontractorboolean

If this is true, allows users to join subcontractors

Example request

{
  "name": "Site Orientation Bundle",
  "siteId": 1,
  "items": [
    {
      "itemId": 123
    }
  ]
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "id": 1,
    "url": "https://portal.salussafety.io/public/action/86E69EFA-2A59-4A38-BBC6-AA6AA62BFB08",
    "name": "Downtown Info Packet",
    "entity": "bundle",
    "shortCode": "de8b0x"
  }
}