Endpoint: Searching Tests

This endpoint lets you search for your own tests. You can apply pagination using the query parameters and apply filters using the request body.

Request Body

{
  folder?: string[];
  labels?: string[];
  favorite?: boolean;
  title?: string;
}

• title: The value to filter tests by their titles (case insensitive). The tests whose title contain the filter value will be returned.

Response

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

The response will include only the tests that satisfy all of the filters provided in the request body.

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;
   }[];
}