API Docs

Use our API to integrate PDFQuiz with your applications. API access is available in the Elite plan.

Authorization

Generate an API token in the menu in your account (/user/api-tokens). Use the token to authorize yoru requests.

GET /api/invitees

List all invitees from all quizzes with scores

This endpoint allows you to retrieve a list of all invitees for all quizzes.

Request

GET
/api/invitees 
curl -G https://pdfquiz.com/api/invitees \
-H "Authorization: Bearer {token}" \

Response

[
   {
      "email":"invitee1@pdfquiz.com",
      "name":John Doe,
      "score":80,
      "finished":1,
      "created_at":"2025-01-30T15:18:26.000000Z",
      "quiztake_hash":"G43Rwn-lP34SD-HZ34uu-rp34xg",
      "quiz_id": 123,
      "quiz_filename": "test.pdf",
      "quiz_name": null
   },
   {
      "email":"invitee2@pdfquiz.com",
      "name":null,
      "score":null,
      "finished":null,
      "created_at":"2025-01-30T15:19:13.000000Z",
      "quiztake_hash":"12tQcL-sU12bx-u43402-wdfYVd"
      "quiz_id": 1222,
      "quiz_filename": "test2.pdf",
      "quiz_name": null
   }
]
GET /api/invitees/{quiz_id}

List all invitees from a quiz with scores

This endpoint allows you to retrieve a list of all invitees for all quizzes. Copy the quiz ID from quiz settings in your dashboard.

Request

GET
/api/invitees/{quiz_id} 
curl -G https://pdfquiz.com/api/invitees/{quiz_id} \
-H "Authorization: Bearer {token}" \

Response

[
   {
      "email":"invitee1@pdfquiz.com",
      "name":John Doe,
      "score":80,
      "finished":1,
      "created_at":"2025-01-30T15:18:26.000000Z",
      "quiztake_hash":"G43Rwn-lP34SD-HZ34uu-rp34xg"
   },
   {
      "email":"invitee2@pdfquiz.com",
      "name":null,
      "score":null,
      "finished":null,
      "created_at":"2025-01-30T15:19:13.000000Z",
      "quiztake_hash":"12tQcL-sU12bx-u43402-wdfYVd"
   }
]