Questions

Resource description

Questions define additional fields that need to be filled out by customers during checkout. The question resource contains the following public fields:

Field

Type

Description

id

integer

Internal ID of the question

question

multi-lingual string

The field label shown to the customer

help_text

multi-lingual string

The help text shown to the customer

type

string

The expected type of answer. Valid options:

  • N – number

  • S – one-line string

  • T – multi-line string

  • B – boolean

  • C – choice from a list

  • M – multiple choice from a list

  • F – file upload

  • D – date

  • H – time

  • W – date and time

  • CC – country code (ISO 3666-1 alpha-2)

  • TEL – telephone number

required

boolean

If true, the question needs to be filled out.

position

integer

An integer, used for sorting

items

list of integers

List of item IDs this question is assigned to.

identifier

string

An arbitrary string that can be used for matching with other sources.

ask_during_checkin

boolean

If true, this question will not be asked while buying the ticket, but will show up when redeeming the ticket instead.

hidden

boolean

If true, the question will only be shown in the backend.

print_on_invoice

boolean

If true, the question will only be shown on invoices.

options

list of objects

In case of question type C or M, this lists the available objects. Only writable during creation, use separate endpoint to modify this later.

├ id

integer

Internal ID of the option

├ position

integer

An integer, used for sorting

├ identifier

string

An arbitrary string that can be used for matching with other sources.

└ answer

multi-lingual string

The displayed value of this option

valid_number_min

string

Minimum value for number questions (optional)

valid_number_max

string

Maximum value for number questions (optional)

valid_date_min

date

Minimum value for date questions (optional)

valid_date_max

date

Maximum value for date questions (optional)

valid_datetime_min

datetime

Minimum value for date and time questions (optional)

valid_datetime_max

datetime

Maximum value for date and time questions (optional)

valid_file_portrait

boolean

Turn on file validation for portrait photos

dependency_question

integer

Internal ID of a different question. The current question will only be shown if the question given in this attribute is set to the value given in dependency_value. This cannot be combined with ask_during_checkin.

dependency_values

list of strings

If dependency_question is set to a boolean question, this should be ["True"] or ["False"]. Otherwise, it should be a list of identifier values of question options.

dependency_value

string

An old version of dependency_values that only allows for one value. Deprecated.

Endpoints

GET /api/v1/organizers/(organizer)/events/(event)/questions/

Returns a list of all questions within a given event.

Example request:

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

Example response:

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

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "question": {"en": "T-Shirt size"},
      "help_text": {"en": "Choose your preferred t-shirt-size"},
      "type": "C",
      "required": false,
      "items": [1, 2],
      "position": 1,
      "identifier": "WY3TP9SL",
      "ask_during_checkin": false,
      "hidden": false,
      "print_on_invoice": false,
      "valid_number_min": null,
      "valid_number_max": null,
      "valid_date_min": null,
      "valid_date_max": null,
      "valid_datetime_min": null,
      "valid_datetime_max": null,
      "valid_file_portrait": false,
      "dependency_question": null,
      "dependency_value": null,
      "dependency_values": [],
      "options": [
        {
          "id": 1,
          "identifier": "LVETRWVU",
          "position": 0,
          "answer": {"en": "S"}
        },
        {
          "id": 2,
          "identifier": "DFEMJWMJ",
          "position": 1,
          "answer": {"en": "M"}
        },
        {
          "id": 3,
          "identifier": "W9AH7RDE",
          "position": 2,
          "answer": {"en": "L"}
        }
      ]
    }
  ]
}
Query Parameters
  • page (integer) – The page number in case of a multi-page result set, default is 1

  • ordering (string) – Manually set the ordering of results. Valid fields to be used are id and position. Default: position

  • identifier (string) – Only return questions with the given identifier string

  • ask_during_checkin (boolean) – Only return questions that are or are not to be asked during check-in

  • required (boolean) – Only return questions that are or are not required to fill in

Parameters
  • organizer – The slug field of the organizer to fetch

  • event – The slug field of the event to fetch

Status Codes
  • 200 OK – no error

  • 401 Unauthorized – Authentication failure

  • 403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.

GET /api/v1/organizers/(organizer)/events/(event)/questions/(id)/

Returns information on one question, identified by its ID.

Example request:

GET /api/v1/organizers/bigevents/events/sampleconf/questions/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

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

{
  "id": 1,
  "question": {"en": "T-Shirt size"},
  "help_text": {"en": "Choose your preferred t-shirt-size"},
  "type": "C",
  "required": false,
  "items": [1, 2],
  "position": 1,
  "identifier": "WY3TP9SL",
  "ask_during_checkin": false,
  "hidden": false,
  "print_on_invoice": false,
  "valid_number_min": null,
  "valid_number_max": null,
  "valid_date_min": null,
  "valid_date_max": null,
  "valid_datetime_min": null,
  "valid_datetime_max": null,
  "valid_file_portrait": false,
  "dependency_question": null,
  "dependency_value": null,
  "dependency_values": [],
  "options": [
    {
      "id": 1,
      "identifier": "LVETRWVU",
      "position": 1,
      "answer": {"en": "S"}
    },
    {
      "id": 2,
      "identifier": "DFEMJWMJ",
      "position": 2,
      "answer": {"en": "M"}
    },
    {
      "id": 3,
      "identifier": "W9AH7RDE",
      "position": 3,
      "answer": {"en": "L"}
    }
  ]
}
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 question to fetch

Status Codes
  • 200 OK – no error

  • 401 Unauthorized – Authentication failure

  • 403 Forbidden – The requested organizer/event does not exist or you have no permission to view this resource.

POST /api/v1/organizers/(organizer)/events/(event)/questions/

Creates a new question

Example request:

POST /api/v1/organizers/bigevents/events/sampleconf/questions/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json

{
  "question": {"en": "T-Shirt size"},
  "help_text": {"en": "Choose your preferred t-shirt-size"},
  "type": "C",
  "required": false,
  "items": [1, 2],
  "position": 1,
  "ask_during_checkin": false,
  "hidden": false,
  "print_on_invoice": false,
  "dependency_question": null,
  "dependency_values": [],
  "options": [
    {
      "answer": {"en": "S"}
    },
    {
      "answer": {"en": "M"}
    },
    {
      "answer": {"en": "L"}
    }
  ]
}

Example response:

HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json


{
  "id": 1,
  "question": {"en": "T-Shirt size"},
  "help_text": {"en": "Choose your preferred t-shirt-size"},
  "type": "C",
  "required": false,
  "items": [1, 2],
  "position": 1,
  "identifier": "WY3TP9SL",
  "ask_during_checkin": false,
  "hidden": false,
  "print_on_invoice": false,
  "dependency_question": null,
  "dependency_value": null,
  "dependency_values": [],
  "valid_number_min": null,
  "valid_number_max": null,
  "valid_date_min": null,
  "valid_date_max": null,
  "valid_datetime_min": null,
  "valid_datetime_max": null,
  "valid_file_portrait": false,
  "options": [
    {
      "id": 1,
      "identifier": "LVETRWVU",
      "position": 1,
      "answer": {"en": "S"}
    },
    {
      "id": 2,
      "identifier": "DFEMJWMJ",
      "position": 2,
      "answer": {"en": "M"}
    },
    {
      "id": 3,
      "identifier": "W9AH7RDE",
      "position": 3,
      "answer": {"en": "L"}
    }
  ]
}
Parameters
  • organizer – The slug field of the organizer of the event to create an item for

  • event – The slug field of the event to create an item for

Status Codes
PATCH /api/v1/organizers/(organizer)/events/(event)/questions/(id)/

Update a question. You can also use PUT instead of PATCH. With PUT, you have to provide all fields of the resource, other fields will be reset to default. With PATCH, you only need to provide the fields that you want to change.

You can change all fields of the resource except the options field. If you need to update/delete options please use the nested dedicated endpoints.

Example request:

PATCH /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json
Content-Length: 94

{
  "position": 2
}

Example response:

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

{
  "id": 1,
  "question": {"en": "T-Shirt size"},
  "help_text": {"en": "Choose your preferred t-shirt-size"},
  "type": "C",
  "required": false,
  "items": [1, 2],
  "position": 2,
  "identifier": "WY3TP9SL",
  "ask_during_checkin": false,
  "hidden": false,
  "print_on_invoice": false,
  "dependency_question": null,
  "dependency_value": null,
  "dependency_values": [],
  "valid_number_min": null,
  "valid_number_max": null,
  "valid_date_min": null,
  "valid_date_max": null,
  "valid_datetime_min": null,
  "valid_datetime_max": null,
  "valid_file_portrait": false,
  "options": [
    {
      "id": 1,
      "identifier": "LVETRWVU",
      "position": 1,
      "answer": {"en": "S"}
    },
    {
      "id": 2,
      "identifier": "DFEMJWMJ",
      "position": 2,
      "answer": {"en": "M"}
    },
    {
      "id": 3,
      "identifier": "W9AH7RDE",
      "position": 3,
      "answer": {"en": "L"}
    }
  ]
}
Parameters
  • organizer – The slug field of the organizer to modify

  • event – The slug field of the event to modify

  • id – The id field of the question to modify

Status Codes
  • 200 OK – no error

  • 400 Bad Request – The item could not be modified due to invalid submitted data

  • 401 Unauthorized – Authentication failure

  • 403 Forbidden – The requested organizer/event does not exist or you have no permission to change this resource.

DELETE /api/v1/organizers/(organizer)/events/(event)/questions/(id)/

Delete a question.

Example request:

DELETE /api/v1/organizers/bigevents/events/sampleconf/items/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript

Example response:

HTTP/1.1 204 No Content
Vary: Accept
Parameters
  • organizer – The slug field of the organizer to modify

  • event – The slug field of the event to modify

  • id – The id field of the item to delete

Status Codes