SambaSafety REST API
Number of APIs: 79
Our SambaSafety RESTful Endpoints are used by customers in a wide variety of industries, and supports a range of license verification, underwriting, and risk assessment workflows. It also drives our Qorta application, which is available to all of SambaSafety's Enterprise organizations and partners, and is used to manage employees and drivers.
Getting Started
This collection can be used to validate your SambaSafety Credentials, with Demo or Production. We offer this collection publicly to assist you in implementing your solution with our APIs. It's meant to jump start your exploration.
This collection can be forked, copied or imported into your own team workspace.
Additional Information about this Collection is available on our Developers Portal
About This Collection
This collection was created using OpenAPI Specification version 3.0 and is available in JSON and YAML versions on our Developers Portal.
- This collection was generated from
sambasafety-openapi-v2.0.4.json - The Tests written in this collection are for v2.0.4 JSON Report Responses
Working With Variables
This demo collection contains a set of variables to populate Requests. These variables are those common elements that will be used in your integration. Updating the Current Value
in the varibles allow quickly mocking and testing an application.
Environments
This collection looks for these environment variables. You can duplicate the Mock Environmentin your workspace as many times as needed.
| Name | Use |
|---|---|
baseUrl | Environment URL |
apiKey | SambaSafetey Credentials |
basicAuthUsername | SambaSafetey Credentials |
basicAuthPassword | SambaSafetey Credentials |
bearerToken | Authentication Token |
Collection Variables
Path Variables
These UUID are path variables are used in the URL to identify a specific data resource.
| Name | Use |
|---|---|
groupId | Access a Stored Group |
personId | Access a Stored Person |
licenseId | Access a Stored License |
userId | Access a Application User (Qorta) |
orderId | Access a Submitted Order |
reportId | Access a Report (Data Dictionary) |
subscriptionId | Access a Webhook Event Subscription |
eventId | Access a Webhook Event |
? Query Variables
These query variables are used in the URL to filter large sets of data.
| Name | Use |
|---|---|
page | Change a page of results |
size | Change the number of items returned on a page. |
startDate | The start date. |
endDate | The end date. |
Accept Header Variables
These header variables are used in the Accept header to return the specified Report Specification.
| Name | Use |
|---|---|
| qorta.accept.header | application/vnd.sambasafety.qorta.mvr+json |
| volta.accept.header | application/vnd.sambasafety.json |
-
License Monitoring - Read a License Enrollment GET {{baseUrl}}/monitoring/v1/licenseenrollments/:licenseId
-
Roster Management-User Groups - Remove User Group Access DELETE {{baseUrl}}/organization/v1/users/:userId/groups
-
Roster Management-Users - Delete User DELETE {{baseUrl}}/organization/v1/users/:userId
-
Activity Reports-Activity Detail - Place a Quote Order POST {{baseUrl}}/orders/v1/activityreports/detailquote
-
Authentication - Obtain a Bearer Token POST {{baseUrl}}/oauth2/v1/token
-
Authentication - Revoke a Bearer Token POST {{baseUrl}}/oauth2/v1/revoke
-
Callback Subscriptions - Create an Event Subscription POST {{baseUrl}}/reports/v1/subscriptions
-
Roster Management-People - Move a Person to a Group PUT {{baseUrl}}/organization/v1/groups/:groupId/people/:personId
-
Roster Management-People - Read a Person GET {{baseUrl}}/organization/v1/people/:personId
-
Roster Management-People - Update a Person PUT {{baseUrl}}/organization/v1/people/:personId