Tests

List tests

Every test in your organisation, most recently updated first, including those created in the Acadine dashboard rather than through this API. Deleted tests are never returned.

Narrow the list with course_id, subject_id, question_paper_id or status. Page with page and size; keep going while pagination.has_next_page is true.

get/v1/tests

Request

Base URL: https://api.acadine.ai (the document declares no server; this is the origin it was published from)
URL: https://api.acadine.ai/v1/tests
Auth: API key in header X-API-Key

Query parameters

course_idstring nullable

Restrict to one course.

subject_idstring nullable

Restrict to one subject.

question_paper_idstring nullable

Restrict to tests backed by one question paper.

status'CREATED' | 'COMPLETED' | 'CANCELLED'

Lifecycle of a test. Mirrors the internal TestStatus one-for-one.

Restrict to one lifecycle status.

pageinteger

sizeinteger

Response

Successful Response

Example response

{
  "tests": [
    {
      "test_id": "TST_2msnplIgOEXImjfvuihUqhIqNJO",
      "name": "Physics Term 1 — Morning",
      "question_paper_id": "QPR_2msnplIgOEXImjfvuihUqhIqNJO",
      "course_id": "ORG_CRS_2msnplIgOEXImjfvuihUqhIqNJO",
      "subject_id": "ORG_SUB_2msnplIgOEXImjfvuihUqhIqNJO",
      "total_marks": 100,
      "duration_mins": 180,
      "batch_ids": [
        "BCH_2msnplIgOEXImjfvuihUqhIqNJO"
      ],
      "created_by": {
        "id": "USR_2msnplIgOEXImjfvuihUqhIqNJO",
        "name": "Anita Sharma"
      },
      "external_test_ref": "their-test-4471"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 50,
    "total_count": 137,
    "total_pages": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.