Our REST API is a core building block of the GoAudits Platform. You can use it to retrieve information from your own GoAudits account, or to integrate GoAudits into your own product. It's completely up to you and your custom use case.
Important: GoAudits REST API is only available on Enterprise plans. Please contact your account manager for more information.
Available Endpoints
Here is what our GoAudits API lets you do. The API is organized around the following resources:
Important: To see the full list of GoAudits API methods and additional details from our REST API, head over to our API developer hub.
API Area | Resource Area | Description |
Authentication |
| Generates the access token required to use the API. Important: You must generate the token before using any of the resources below. |
Action Plan |
| List of Action Items by Audit ID |
Action Plan |
| View a list of Action Plans |
Audit Details |
| View a list of your Audits |
Audit Details |
| View the details of a specific Audit |
Audit Details |
| View a summary list of of your Audits |
Checklists |
| View a list of your checklists |
Companies |
| View a list of your companies |
Locations |
| View a list of your locations |
Users |
| View a list of your users |
Export Audits |
| Export your Audits Details data in EXCEL or CSV file format |
Export Audits |
| Export your Audits Summary data in EXCEL or CSV file format |
Export User |
| Export your users data in EXCEL or CSV file format |
Authentication
To access the GoAudits API, you'll need an access token. To generate one, send a POST request to https://api.goaudits.com/v1/api/auth/authenticate with the following input data: { "user_name":"example@test.com", "usr_pwd":"password" } - please replace "example@test.com" and "password" with your credentials, as shown below.
$ curl \
-X POST "https://api.goaudits.com/v1/api/auth/authenticate" \
-H 'Accept:application/json' \
-H 'Content-Type: application/json' \
-d "{\"user_name\":\"<your_username>\",\"usr_pwd\":\"<your_password>\"}"
How to use the GoAudits API token
Once you have a token, simply provide it as an Authorization:Bearer
header in your requests, as shown below.
$ curl -X POST "https://api.goaudits.com/v1/audits/userlist" \
-H "accept: */*" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" -d "{ \"user_name\": \"string\"}"
To see the full list of GoAudits API methods and additional details from our REST API, head over to our API developer hub now.