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

https://api.goaudits.com/v1/api/auth/authenticate

Generates the access token required to use the API. Important: You must generate the token before using any of the resources below.

Action Plan

https://api.goaudits.com/v1/audits/actionplandetails

List of Action Items by Audit ID

Action Plan

https://api.goaudits.com/v1/audits/actionplanlist

View a list of Action Plans

Audit Details

https://api.goaudits.com/v1/audits/auditdetails

View a list of your Audits

Audit Details

https://api.goaudits.com/v1/audits/auditdetailsbyid

View the details of a specific Audit

Audit Details

https://api.goaudits.com/v1/audits/auditsummary 

View a summary list of of your Audits

Checklists

https://api.goaudits.com/v1/audits/checklists 

View a list of your checklists

Companies

https://api.goaudits.com/v1/audits/companieslist 

View a list of your companies

Locations

https://api.goaudits.com/v1/audits/locations

View a list of your locations

Users

https://api.goaudits.com/v1/audits/userlist

View a list of your users

Export Audits

https://api.goaudits.com/v1/export/auditdetails

Export your Audits Details data in EXCEL or CSV file format

Export Audits

https://api.goaudits.com/v1/export/auditsummary

Export your Audits Summary data in EXCEL or CSV file format

Export User

https://api.goaudits.com/v1/export/userlist

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.

Did this answer your question?