v1

latestOpenAPI 3.1.02026-08-065143121.0 KB

Event

Lista os eventos

Retorna uma lista paginada de eventos do produtor autenticado

get/v1.6.0/events

Query parameters

publishedstring required

Filtra eventos pelo status de publicação. Valores aceitos: published (ou true), not_published (ou false), all (não aplica filtro). Padrão: true (equivalente a published).

Example:published

Filtra eventos pelo status de publicação. Valores aceitos: published (ou true), not_published (ou false), all (não aplica filtro). Padrão: true (equivalente a published).

fromstring date-time

Data/hora inicial (ISO-8601 local na timezone informada).

timezonestring required

Timezone IANA aplicada às datas de entrada/saída. Padrão: America/Sao_Paulo.

Example:America/Sao_Paulo

Timezone IANA aplicada às datas de entrada/saída. Padrão: America/Sao_Paulo.

sortstring required

Direção da ordenação: asc (padrão) | desc.

Example:asc

Direção da ordenação: asc (padrão) | desc.

field_sortstring

Campo de ordenação. Valores: start_date (padrão), end_date, name.

page_sizeinteger

Quantidade de itens por página (1–200). Padrão: 100.

cursorstring

Cursor de paginação retornado em pagination.next_cursor para buscar a próxima página.

fieldsstring

Campos a retornar, separados por vírgula (snake_case). Disponíveis: id, reference_id, start_date, end_date, name, detail, private_event, published, cancelled, image, url, address, host, category_prim, category_sec.

Response

Success

Example response

{
  "data": [
    {
      "address": {
        "address_num": "string",
        "city": "string",
        "country": "string",
        "lat": 0.1,
        "lon": 0.1,
        "name": "string",
        "state": "string"
      },
      "category_prim": {
        "name": "string"
      },
      "end_date": "2026-06-18T19:12:37.547Z",
      "host": {
        "description": "string",
        "name": "string"
      },
      "id": "string",
      "image": "string",
      "name": "teste agrupamento dezembro 2026",
      "private_event": 1,
      "published": 1,
      "reference_id": 0,
      "start_date": "2026-06-18T19:12:37.547Z",
      "url": "string"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "page_size": 0,
    "quantity": 0
  },
  "sort": {
    "field_sort": "string",
    "sort": "string"
  }
}