Skip to main content

Get List

GET 
/api/tests

API Endpoint: Retrieve Tests​

Purpose​

This endpoint is used to retrieve a list of tests available in the system. It allows users to access test data, which can be utilized for various purposes such as analytics, reporting, or integration with other services.

Request Method​

  • GET

Request Parameters​

This endpoint does not require any input parameters in the request.

Response Structure​

The response will contain a JSON object with the following structure:

  • status: Indicates the success or failure of the request (e.g., "success" or "error").
  • data: An array of test objects, where each test object may include:
    • id: Unique identifier for the test.
    • name: The name of the test.
    • description: A brief description of what the test entails.
    • created_at: Timestamp indicating when the test was created.
    • updated_at: Timestamp indicating when the test was last updated.

Example Response​

{
	"status": "success",
	"data": [
		{
			"id": "1",
			"name": "Test A",
			"description": "Description of Test A",
			"created_at": "2023-01-01T00:00:00Z",
			"updated_at": "2023-01-02T00:00:00Z"
		},
		{
			"id": "2",
			"name": "Test B",
			"description": "Description of Test B",
			"created_at": "2023-01-03T00:00:00Z",
			"updated_at": "2023-01-04T00:00:00Z"
		}
	]
}

This endpoint is essential for users who need to access and manage the tests available within the application.

Responses​