Testinvite offers a REST API system for clients to integrate our system into theirs and automate the workflow.
The REST API services include the following:
To authenticate requests to the API, include your access key's authorization token in the Authorization header of each HTTP request. You can find your unique token on your organization's page. Use the following format:
To test if the API service is active and authentication is set up properly, you can use the endpoint below. A successful request means everything is good to go.
Please find below the endpoints for the REST API service. Make sure to when using these endpoints, the access key being used has the appropriate permissions.
| Resource | Purpose | Route | HTTP Method | Documentation |
| Tests | Fetch multiple tests | /v1/tests | GET | Click |
| Search for tests with filters | /v1/tests/filter | POST | Click | |
| Fetch one test by its id | /v1/tests/:id | GET | Click | |
| Users | Fetch multiple users | /v1/users | GET | Click |
| Search for users with filters | /v1/users/filter | POST | Click | |
| Fetch one user by its id | /v1/users/:id | GET | Click | |
| Fetch one user by its id and get additional details | /v1/users/:id/expand | POST | Click | |
| Tasks | Fetch multiple tasks | GET | Click | |
| Search for tasks with filters | /v1/tasks/filter | POST | Click | |
| Fetch one task by its id | /v1/tasks/:id | GET | Click | |
| Candidate | Fetch one candidate under a task by their id | /v1/tasks/:taskId/candidates/:id | GET | Click |
| Fetch multiple candidates | /v1/tasks/:taskId/candidates | GET | Click | |
| Create a new candidate under a task | /v1/tasks/:taskId/candidates | POST | Click | |
| Test instances | Fetch multiple test instances | /v1/tasks/:taskId/test-instances | GET | Click |
| Search for test instances with filters | /v1/tasks/:taskId/test-instances/filter | POST | Click | |
| Fetch one test instance by its id | /v1/tasks/:taskId/test-instances/:id | GET | Click | |
| Fetch one test instance by its id and get additional details | /v1/tasks/:taskId/test-instances/:id/expand | POST | Click | |
| Proctoring Evidences | Fetch proctoring evidences of a test session | /v1/tasks/:taskId/test-instances/:id/proctoring-evidences | GET | Click |
| Answers | Fetch all answers of a test session | /v1/tasks/:taskId/test-instances/:id/answers | GET | Coming Soon |
