Skip to main content
GET
Search and filter assessment items

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

query
string

Search title and identifier fields using a search term. This is a fuzzy search.

page
integer
default:1

Page number for pagination

Required range: x >= 1
Example:

1

limit
integer
default:10

Number of items per page

Required range: 1 <= x <= 1000
Example:

10

sort
enum<string>
default:createdAt

Field to sort by

Available options:
title,
identifier,
type,
createdAt,
updatedAt
Example:

"createdAt"

order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

filter
string

Advanced filter expression using =, !=, >, >=, <, <=, ~ and logical AND/OR. Example: type='choice'

Example:

"type='choice'"

subject
string

Only items that an assessment test with this subject references

Example:

"Math"

grade
string

Only items that an assessment test with this grade references

Example:

"5"

type
string

Filter by question type - native field with simple index

Example:

"choice"

Case-insensitive substring search on qti-prompt-text

Example:

"pythagorean"

Response

List of assessment items with pagination metadata

Paginated response containing all assessment items available on the service provider with navigation metadata

items
object[]
required

Array of assessment items that match the search criteria

total
number
required

The total number of entities that match the search criteria.

page
number
default:1
required

The page number of the entities that match the search criteria.

pages
number
required

The total number of pages of entities that match the search criteria.

limit
number
default:10
required

The number of entities per page.

sort
string
required

The field to sort the entities by.

order
enum<string>
required

The order to sort the entities by. Either 'asc' or 'desc'.

Available options:
asc,
desc