Получить список событий

GET /v1/events

Группа: События

Получение публичной информации о событиях не требует аутентификации. Количество запросов в минуту ограничено.

fields

Список полей, которые нужно вывести

query string[]
limit

Сколько элементов списка вывести

query integer , { x ∈ ℤ | 1 ≤ x ≤ 100 } 10
skip

С какого элемента списка начать вывод

query integer , { x ∈ ℤ | x ≥ 0 }
sort

Поле, по которому сортировать

query string[] +name
category_ids

Категории, к которым принадлежат события

query integer[]
category_ids_exclude

Категории, к которым не принадлежат события

query integer[]
cities

Города, события из которых выводить

query string[]
cities_exclude

Города, события из которых не выводить

query string[]
organization_ids

Номера организаций, события из которых выводить

query integer[]
organization_ids_exclude

Номера организаций, события из которых не выводить

query integer[]
event_ids

Номера событий, которые нужно вывести

query integer[]
event_ids_exclude

Номера событий, которые нужно пропустить

query integer[]
keywords

Слова, которые должны быть в названии или описании события

query string[]
keywords_exclude

Слова, которых не должно быть в названии или описании события

query string[]
access_statuses

Список режимов доступа, в которых находятся события. Возможные значения: private, draft, link_only, public. Доступно только организаторам

query string[] public
moderation_statuses

Список уровней качества, установленных для события модератором. Возможные значения: featured, shown, hidden, not_moderated.

query string[] featured,shown,not_moderated
price_min

Цена, выше которой должен стоить хотя бы один билет события

query integer
price_max

Цена, ниже которой должен стоить хотя бы один билет события

query integer
ad_partner_percent_min

Хотя бы у одного вида билета события партнёрская комиссия в процентах выше этого значения

query integer
ad_partner_percent_max

Хотя бы у одного вида билета партнёрская комиссия в процентах ниже этого значения

query integer
ad_partner_profit_min

Хотя бы у одного вида билета партнёрская комиссия в рублях выше этого значения

query integer
ad_partner_profit_max

Хотя бы у одного вида билета партнёрская комиссия в рублях ниже этого значения

query integer
starts_at_min

Дата начала события позднее этого значения

query string (date-time)
starts_at_max

Дата начала события раньше этого значения

query string (date-time)
created_at_min

Дата создания события на Timepad позднее этого значения

query string (date-time)
created_at_max

Дата создания события на Timepad раньше этого значения

query string (date-time)

Список событий

total: integer

Общее количество найденных событий

values: EventResponse[]

Массив с выборкой событий

id: integer

Уникальный номер события

created_at: string (date)

Дата создания события

starts_at: string (date)

Дата начала события

ends_at: string (date)

Дата конца события

name: string

Название события

description_short: string

Короткое описание события или подзаголовок

description_html: string

Полное описание события

url: string

Адрес события в timepad

poster_image: ImageResponse
default_url: string

Картинка стандартного размера

uploadcare_url: string

Адрес картинки на uploadcare, к которому можно прибавлять запросы в формате uploadcare

Картинка события

ad_partner_percent: integer

Процент, который получают партнёры за продажу билета на это событие

locale: string

Язык события по умолчанию

location: LocationResponse
country: string

Название страны

city: string

Название города

address: string

Адрес проведения события

coordinates: number[]

Широта и долгота для карт

number

Место проведения события

organization: OrganizationResponse
id: integer

Номер организации

name: string

Название организации

description_html: string

Описание организации

url: string

URL организации на сайте

logo_image: ImageResponse
default_url: string

Картинка стандартного размера

uploadcare_url: string

Адрес картинки на uploadcare, к которому можно прибавлять запросы в формате uploadcare

Логотип

subdomain: string

URL-идентификатор организации в Таймпаде (*.timepad.ru)

permissions: string[]

Настройки доступов для организаций

string

Организация, проводящая событие

categories: CategoryResponse[]

Категории события

id: integer

Уникальный номер категории

name: string

Название категории

tickets_limit: integer

Максимальное количество человек, которые могут посетить событие

ticket_types: TicketTypeResponse[]

Доступные типы билетов

id: integer

Уникальный номер типа билета

name: string

Название типа билета

description: string

Описание типа билета

buy_amount_min: number

Минимальное количество билетов в одной покупке

buy_amount_max: number

Максимальное количество билетов в одной покупке

price: number

Цена билета

is_promocode_locked: boolean

Закрыт ли этот тип билета введённым промокодом

remaining: integer

Сколько билетов осталось

sale_ends_at: string (date)

Дата окончания продажи типа билета

sale_starts_at: string (date)

Дата начала продажи типа билета

public_key: string

Публичный ключ для расшифровки QR-кода билета этого типа

is_active: boolean

Активность типа билета

ad_partner_profit: number

Партнёрская прибыль

send_personal_links: boolean

Отправка персональных сссылок

sold: number

Количество проданных билетов

attended: number

Количество посетивших людей

limit: number

Ограничение на количество билетов в этом типе билета

status: string

Статус типа билета

personal_links: string[]

Персональные ссылки. Доступно только при указании токена со разрешением view_private_events

string
questions: QuestionResponse[]

Вопросы, задающиеся при регистрации

field_id: integer

Уникальный текстовый идентификатор вопроса

name: string

Текст вопроса

comment: string

Подсказка под вопросом

type: string , x ∈ { text , multiline_text , select_one , select_many , upload , agree }

Тип вопроса

possible_answers: AnswerResponse[]

Список предлагаемых ответов (если вопрос предполагает такой список)

id: integer

Уникальный номер ответа

name: string

Текст ответа

is_mandatory: boolean

Является ли ответ на вопрос обязательным

is_for_every_visitor: boolean

Выводить вопрос отдельно для каждого купленного билета

meta: object

Дополнительные данные

widgets: WidgetResponse[]

Виджеты, доступные для события

code_html: string

Код вставки виджета в сайт

properties: string[]

Список особенностей события

string
moderation_status: string

Статус модерации

access_status: string

Статус доступа к событию

registration_data: RegistrationDataResponse
price_max: number

Цена самого дорогого билета

price_min: number

Цена самого дешёвого билета

sale_ends_at: string (date)

Дата окончания продажи последней категории билета

tickets_total: integer

Количество забронированных, проданных и бесплатных билетов

tickets_limit: integer

Максимальное количество доступных билетов, независимо от типа билета

is_registration_open: boolean

Открыта ли регистрация

Обобщённые данные о билетах

is_sending_free_tickets: boolean

Отправлять билеты на бесплатные регистрации

personal_link_title: string

Заголовок персональной ссылки. Доступно только при указании токена со разрешением view_private_events

view_private_events