Public API

For more information about upgrading your SiteDocs Package, click here!

How Does It Work?

An API (Application Programming Interface) makes it possible for software programs to exchange information by providing the language they need to understand each other.

A common scenario would be using API to automatically create a new Worker in your SiteDocs account when a new employee is added to your Human Resources program. The API would send the employee information from the HR software to SiteDocs in the language SiteDocs accepts. SiteDocs uses a REST API only.

After signing up for API access, SiteDocs provides you with the required authorization token for your account so that your team can execute specific commands using the Public API. Since API access is an advanced feature, customers must have the internal resources (a capable IT person/ Department who is knowledgeable about how to integrate APIs) to utilize it.

Who implements and manages API?

The SiteDocs API is self-service, meaning you or your IT person/Department will implement and manage the API integration.

The SiteDocs Support Team is equipped to provide you with your authorization token and to answer basic questions related to what functions our API is able to do.

Is there a limit to the number of API calls?

We are not currently imposing a limit on API usage though we will reserve the right to do so if we find it is being abused. 

What operations are included?

The SiteDocs API currently includes:

• Locations
• Workers
• Certifications
• Certification Types
• Forms and Form data
• Signatures and sets of signatures (Form, Worker who signed it, and date) 
• Signature image
• Dropdown List content
• Worker and Location management (Active and Inactive)
• Synchronous Admin/Mobile Access/ Worker activation endpoints
• Mobile and Administrator management (upgrading and revoking)
• Preventing Administrator from removing privileges on own account 
• More!

See API documentation here

Click on the "Show/Hide" button on the Swagger page to expand each category and see the available options, and a summary of each option.

Click on each option to expand with further options, Response Messages, and testing capabilities with your API Token.

How does my company get access?

Contact [e-mail] to request access for your company.