Certificates of attendance

The certificates plugin provides a HTTP API that allows you to download the certificate for a specific attendee.

Certificate download

GET /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/certificate/

Downloads the certificate for one order position, identified by its internal ID. Download is a two-step process. You will always get a 303 See Other response with a Location header to a different URL. In the background, our server starts preparing the PDF file.

If you then do a GET to the URL you were given, you will either receive a 409 Conflict response indicating to retry after a few seconds, or a 200 OK response with the PDF file.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/certificate/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 303 See Other
Location: /api/v1/organizers/democon/events/3vjrh/orderpositions/426/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/download/certificate/?result=1f550651-ae7b-4911-a76c-2be8f348aaa5 HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/pdf

...
Parameters:

  • organizer – The slug field of the organizer to fetch

  • event – The slug field of the event to fetch

  • id – The id field of the order position to fetch

Status Codes:

  • 200 OK – File ready for download

  • 303 See Other – Processing started

  • 401 Unauthorized – Authentication failure

  • 403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource or downloads are not available for this order position at this time. The response content will contain more details.

  • 404 Not Found – The requested order position or download provider does not exist.

  • 409 Conflict – The file is not yet ready and will now be prepared. Retry the request after waiting for a few seconds.