Skip to main content
The Partner API lets your platform assign Quippy tests to your users and receive their results, without your users ever creating a Quippy account separately. It’s built for products that embed Quippy assessments into their own flow — an LMS, a certification portal, a recruitment tool.

The flow

  1. List tests — fetch the tests published to your institution.
  2. Assign — create an assignment for one of your users. You get back an assignmentId and a signed startUrl.
  3. Start — your user opens the startUrl. They’re signed in automatically (no password, no separate registration) and land directly on the test.
  4. Results — you receive webhooks as the student starts, submits, and is graded — each carrying your externalUserId and partnerAssignmentId so you can correlate exactly. You can also poll GET /partner/v1/assignments/{id}.
  5. Return — when the student finishes, a “Return to <you>” button sends them back to the callbackUrl you provided.

What you’ll need

An API key

Server-to-server credential, created in the admin portal.

A callback domain

Allowlist the domain your students return to.

Published tests

We curate which of your tests are assignable — ask your Quippy contact.

A webhook endpoint

Recommended, for real-time result delivery.

Conventions

  • Base URL: https://api-sg.quippy-lab.com
  • All requests and responses are JSON.
  • All timestamps are ISO 8601 UTC.
  • All IDs are opaque strings — never parse or depend on their format.
  • The API is versioned in the path (/partner/v1/…). New fields and events may be added without a version bump, so parse tolerantly.
This is a server-to-server API. Your API key must never appear in browser or mobile code — see Authentication.