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


GET /v1/events

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


Описание

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

Параметры

Имя Описание Тип Тип данных
fields Список полей, которые нужно вывести query string[]
limit Сколько элементов списка вывести query integer, { x ∈ ℤ | 1 ≤ x ≤ 100 } 10
skip С какого элемента списка начать вывод query integer, { x ∈ ℤ | x ≥ 0 }
sort Поле, по которому сортировать query string[] +id
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 (отклонено), not_moderated. (неотмодерированно). query string[] featured, shown, not_moderated
price_min Цена, выше которой должен стоить хотя бы один билет события query integer
price_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)

Ответ

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

EventsResponse

total: integer —  «required»
Общее количество найденных событий

values: EventResponse[] — «required»
Массив с выборкой событий

EventResponse

id: integer«required»
Уникальный номер события

created_at: string (date)
Дата создания события

starts_at: string (date) — «required»
Дата начала события

ends_at: string (date)
Дата конца события

name: string«required»
Название события

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

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

url: string — «required»
Адрес события в timepad

poster_image: ImageResponse — «required»
Картинка события

  • default_url: string«required»
    Картинка стандартного размера
  • uploadcare_url: string«required»
    Адрес картинки на uploadcare, к которому можно прибавлять запросы в формате uploadcare

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

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

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

  • country: string«required»
    Название страны
  • city: string«required»
    Название города
  • address: string — «required»
    Адрес проведения события
  • coordinates: number[] — «required»
    Широта и долгота для карт
    number

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

  • id: integer — «required»
    Номер организации
  • name: string — «required»
    Название организации
  • description_html: string — «required» 
    Описание организации
  • url: string«required»
    URL организации на сайте
  • logo_image: ImageResponse «required»
    Логотип
    • default_url: string«required»
      Картинка стандартного размера
    • uploadcare_url: string — «required»
      Адрес картинки на uploadcare, к которому можно прибавлять запросы в формате uploadcare
  • subdomain: string — «required» 
    URL-идентификатор организации в Таймпаде (***.timepad.ru)
  • permissions: string[]
    Настройки доступов для организаций
    string

categories: CategoryResponse[] — «required»
Категории события

CategoryResponse

id: integer — «required»
Уникальный номер категории

name: string«required»
Название категории

 
 

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

ticket_types: TicketTypeResponse[]
Доступные типы билетов

TicketTypeResponse 

id: integer — «required»
Уникальный номер типа билета

name: string«required»
Название типа билета

description: string
Описание типа билета

buy_amount_min: number«required»
Минимальное количество билетов в одной покупке

buy_amount_max: number«required»
Максимальное количество билетов в одной покупке

price: number«required»
Цена билета

is_promocode_locked: boolean«required»
Закрыт ли этот тип билета введённым промокодом

remaining: integer — «required»
Сколько билетов осталось

sale_ends_at: string (date)«required»
Дата окончания продажи типа билета

sale_starts_at: string (date) 
Дата начала продажи типа билета

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

is_active: boolean«required»
Активность типа билета

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[]
Вопросы, задающиеся при регистрации 

QuestionResponse

field_id: integer«required»
Уникальный текстовый идентификатор вопроса

name: string«required»
Текст вопроса

comment: string
Подсказка под вопросом

type: string , x ∈ { text , multiline_text , select_one , select_many , upload , agree }«required»
Тип вопроса

possible_answers: AnswerResponse[]«required»
Список предлагаемых ответов (если вопрос предполагает такой список)

AnswerResponse

id: integer«required»
Уникальный номер ответа

name: string«required»
Текст ответа

 
 

is_mandatory: boolean«required»
Является ли ответ на вопрос обязательным

is_for_every_visitor: boolean«required»
Выводить вопрос отдельно для каждого купленного билета

meta: object«required»
Дополнительные данные

 
 

age_limit: string
Возрастное ограничение события

widgets: WidgetResponse[]
Виджеты, доступные для события

WidgetResponse

code_html: string«required»
Код вставки виджета в сайт 

 
 

properties: string[]
Список особенностей события

  • string

moderation_status: string«required»
Статус модерации

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

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

  • price_max: number«required»
    Цена самого дорогого билета
  • price_min: number«required»
    Цена самого дешёвого билета
  • sale_ends_at: string (date)«required»
    Дата окончания продажи последней категории билета
  • tickets_total: integer — «required»
    Количество забронированных, проданных и бесплатных билетов
  • tickets_limit: integer — «required»
    Максимальное количество доступных билетов, независимо от типа билета
  • is_registration_open: boolean«required»
    Открыта ли регистрация 

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

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

reservation_period: integer
Срок брони билета в часах. Нулевое значение соответствует неограниченному сроку

 
 

 

 
 

Права доступа

Необходимые права доступа — view_private_events

Эта статья была полезной?