Skip to content

Types

types

Return types of the Pretalx API

Documentation: https://docs.pretalx.org/api/resources/index.html

Attention: Quite often the API docs and the actual results of the API differ!

ToDo
  • Find out why extra=Extra.allow causes mypy to fail. Seems like a bug in pydantic.

Answer

answer: str instance-attribute

answer_file: str | None = None class-attribute instance-attribute

id: int instance-attribute

options: list[Option] instance-attribute

person: str | None = None class-attribute instance-attribute

question: AnswerQuestionRef instance-attribute

review: int | None = None class-attribute instance-attribute

submission: str | None = None class-attribute instance-attribute

AnswerQuestionRef

id: int instance-attribute

question: MultiLingualStr instance-attribute

Event

date_from: date instance-attribute

date_to: date | None = None class-attribute instance-attribute

is_public: bool instance-attribute

name: MultiLingualStr instance-attribute

slug: str instance-attribute

timezone: str instance-attribute

urls: URLs instance-attribute

Me

email: str instance-attribute

local: str | None = None class-attribute instance-attribute

name: str instance-attribute

timezone: str instance-attribute

MultiLingualStr

de: str | None = None class-attribute instance-attribute

en: str | None = None class-attribute instance-attribute

model_config = ConfigDict(extra='allow') class-attribute instance-attribute

Option

answer: MultiLingualStr instance-attribute

id: int instance-attribute

Question

contains_personal_data: bool instance-attribute

deadline: datetime | None = None class-attribute instance-attribute

default_answer: str | None = None class-attribute instance-attribute

freeze_after: datetime | None = None class-attribute instance-attribute

help_text: MultiLingualStr instance-attribute

id: int instance-attribute

is_public: bool instance-attribute

is_visible_to_reviewers: bool instance-attribute

max_length: int | None = None class-attribute instance-attribute

min_length: int | None = None class-attribute instance-attribute

options: list[Option] instance-attribute

question: MultiLingualStr instance-attribute

question_required: QuestionRequirement instance-attribute

read_only: bool | None = None class-attribute instance-attribute

required: bool instance-attribute

target: str instance-attribute

variant: str instance-attribute

QuestionRequirement

after_deadline = 'after deadline' class-attribute instance-attribute

optional = 'optional' class-attribute instance-attribute

required = 'required' class-attribute instance-attribute

Resource

description: str instance-attribute

resource: str instance-attribute

Review

answers: list[str] instance-attribute

created: datetime instance-attribute

id: int instance-attribute

score: float | None = None class-attribute instance-attribute

submission: str instance-attribute

text: str | None = None class-attribute instance-attribute

updated: datetime instance-attribute

user: str instance-attribute

Room

availabilities: list[RoomAvailability] | None = None class-attribute instance-attribute

capacity: int | None = None class-attribute instance-attribute

description: MultiLingualStr instance-attribute

id: int instance-attribute

name: MultiLingualStr instance-attribute

position: int | None = None class-attribute instance-attribute

speaker_info: MultiLingualStr | None = None class-attribute instance-attribute

RoomAvailability

end: datetime instance-attribute

start: datetime instance-attribute

Slot

end: datetime instance-attribute

room: MultiLingualStr instance-attribute

room_id: int instance-attribute

start: datetime instance-attribute

Speaker

answers: list[Answer] | None = None class-attribute instance-attribute

availabilities: list[SpeakerAvailability] | None = None class-attribute instance-attribute

submissions: list[str] instance-attribute

SpeakerAvailability

allDay: str = Field(..., alias='all_day') class-attribute instance-attribute

end: str instance-attribute

id: int instance-attribute

start: str instance-attribute

State

accepted = 'accepted' class-attribute instance-attribute

canceled = 'canceled' class-attribute instance-attribute

confirmed = 'confirmed' class-attribute instance-attribute

deleted = 'deleted' class-attribute instance-attribute

rejected = 'rejected' class-attribute instance-attribute

submitted = 'submitted' class-attribute instance-attribute

withdrawn = 'withdrawn' class-attribute instance-attribute

Submission

abstract: str instance-attribute

answers: list[Answer] | None = None class-attribute instance-attribute

code: str instance-attribute

content_locale: str instance-attribute

created: datetime | None = None class-attribute instance-attribute

description: str instance-attribute

do_not_record: bool instance-attribute

duration: int | None = None class-attribute instance-attribute

image: str | None = None class-attribute instance-attribute

internal_notes: str | None = None class-attribute instance-attribute

notes: str | None = None class-attribute instance-attribute

pending_state: State | None = None class-attribute instance-attribute

resources: list[Resource] instance-attribute

slot: Slot | None = None class-attribute instance-attribute

slot_count: int instance-attribute

speakers: list[SubmissionSpeaker] instance-attribute

state: State instance-attribute

submission_type: MultiLingualStr instance-attribute

submission_type_id: int instance-attribute

tag_ids: list[int] | None = None class-attribute instance-attribute

tags: list[str] | None = None class-attribute instance-attribute

title: str instance-attribute

track: MultiLingualStr | None = None class-attribute instance-attribute

track_id: int | None = None class-attribute instance-attribute

SubmissionSpeaker

avatar: str | None = None class-attribute instance-attribute

biography: str | None = None class-attribute instance-attribute

code: str instance-attribute

email: str | None = None class-attribute instance-attribute

name: str instance-attribute

Tag

color: str instance-attribute

description: MultiLingualStr instance-attribute

tag: str instance-attribute

Talk

URLs

base: str instance-attribute

feed: str instance-attribute

login: str instance-attribute

schedule: str instance-attribute

User

email: str instance-attribute

name: str instance-attribute