Endpoint: Listing Tests

Endpoint and request for listing tests
January, 2025
GET /api/integration/rest/v1/tests

This endpoint lets you fetch multiple tests under your organization. You can apply filters and pagination to your request using query parameters. 

Query ParametersExpected ValuesDefault
mode"basic" | "detailed""basic"
limitnumber10
pagenumber1
titlestring
  • mode: The mode of the return value. "detailed" mode will provide more information.
    • title: Ability to filter by title (case insensitive). The query will bring tasks with titles that include the provided value.

      Response

      {
        tests: (Basic | Detailed)[];
        pagination: {
            totalItems: number;
            totalPages: number;
            currentPage: number;
            limit: number;
            next: string | null;
            previous: string | null;
        }
      }

      The type of the tests depends on the value of mode provided in the query parameters. If the value of mode is "basic", the test object in the response will be in this type:

      // "basic" test object:
      {
        testId: string;
        title: string;
        createdAt: number; // seconds
      }

      If the value of mode is "detailed", you will receive all of the properties from "basic" and also these properties:

      // "detailed" test object:
      Basic & {
         organizationId: string;
         description: string;
         timeLimit: number; // seconds
      
         favorite: boolean;
         folder: string;
         labels: string[];
         tags: Record;
      
         sections: {
           uuid: string;
           title: string | null;
           timeLimit: number; //seconds
           noOfPages: number;
         }[];
      }
      Go Back
      Talk to a representative
      Figure out if TestInvite is a good match for your organization
      Book a demo