Skip to main content

List exams

POST 
/exams

Returns a paginated list of all exam records belonging to a workspace.

Get Exams With Tag Filter​

Sample Request​

POST /api/exams
Content-Type: application/json
Authorization: Basic {{appKey}}:{{appSecret}}

{
  "filter": {
    "tags": {
      "include": [
        {
          "key": "is-a-copy",
          "type": "string",
          "value": "yes"
        }
      ],
      "or": [
        {
          "include": [
            {
              "key": "tag-1",
              "type": "string",
              "value": "tag-1-value1"
            }
          ]
        },
        {
          "include": [
            {
              "key": "tag-1",
              "type": "string",
              "value": "tag-1-value3"
            }
          ]
        }
      ]
    }
  }
}

Sample Response​

{
  "items": [
    {
      "id": "73a348be-de46-4efe-ad36-13d722ac40fd",
      "sk": "exam#v0",
      "name": "Exam Created via API 2025-04-08T20:02:41.509Z",
      "idInc": "9542",
      "createdAt": "2025-04-08T20:00:20.662Z",
      "updatedAt": "2025-04-08T20:02:41.943Z",
      "workspaceId": "my-workspace-id"
    }
  ],
  "aggregations": null,
  "nextToken": "WyJpZD03M2EzNDhiZS1kZTQ2LTRlZmUtYWQzNi0xM2Q3MjJhYzQwZmR8c2s9ZXhhbSN2MCJd",
  "total": 1,
  "__typename": "SearchableResourceConnectionNew"
}

Responses​

OK