Sign in

v1

latestOpenAPI 3.1.02026-08-065143121.0 KB
Participants

Lista os participantes de um pedido

Retorna uma lista paginada de participantes associados a um pedido específico de um evento

get/v1.6.0/events/{eventIdHash}/orders/{orderSk}/participants

Path parameters

eventIdHashstring required

Hash do ID do evento

orderSkstring required

Identificador (sk) do pedido

Query parameters

fieldsstring[] required

Campos a retornar, separados por vírgula (snake_case). Disponíveis: id, ticket_status, item_id, event_id, presentation_id, order_id, order_status, order_date, order_updated_at, order_approved_date, order_discount, first_name, last_name, email, ticket_number, ticket_created_at, ticket_updated_at, ticket_num_qr_code, ticket_name, sector_name, marked_place_name, access_information, ticket_sale_price, ticket_net_value, ticket_group_id, ticket_group_name, ticket_subgroup_id, ticket_subgroup_name, checkin, custom_form.

Campos a retornar, separados por vírgula (snake_case). Disponíveis: id, ticket_status, item_id, event_id, presentation_id, order_id, order_status, order_date, order_updated_at, order_approved_date, order_discount, first_name, last_name, email, ticket_number, ticket_created_at, ticket_updated_at, ticket_num_qr_code, ticket_name, sector_name, marked_place_name, access_information, ticket_sale_price, ticket_net_value, ticket_group_id, ticket_group_name, ticket_subgroup_id, ticket_subgroup_name, checkin, custom_form.

[
  "ticket_number,first_name,email"
]
timezonestring required

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

Example:America/Sao_Paulo

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

cancelled_filterstring

Filtro de cancelados: none (padrão) | include | only.

page_sizeinteger

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

cursorstring

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

field_sortstring

Campo de ordenação. Valores: ticket_created_at (padrão), ticket_updated_at.

sortstring

Direção da ordenação: asc | desc.

Response

Success

Example response

{
  "data": [
    {
      "access_information": "string",
      "checkin": {
        "date": "2026-06-18 19:12:37",
        "id": "string"
      },
      "custom_form": {
        "cpf": "string"
      },
      "email": "string",
      "event_id": "string",
      "first_name": "string",
      "id": "string",
      "item_id": "string",
      "last_name": "string",
      "marked_place_name": "string",
      "order_approved_date": "2026-06-18 19:12:37",
      "order_date": "2026-06-18 19:12:37",
      "order_discount": "string",
      "order_id": "string",
      "order_status": "string",
      "order_updated_at": "2026-06-18 19:12:37",
      "presentation_id": "string",
      "sector_name": "string",
      "ticket_created_at": "2026-06-18 19:12:37",
      "ticket_name": "string",
      "ticket_net_value": 0.1,
      "ticket_num_qr_code": "string",
      "ticket_number": "string",
      "ticket_sale_price": 0.1,
      "ticket_status": "string",
      "ticket_updated_at": "2026-06-18 19:12:37"
    }
  ],
  "pagination": {
    "next_cursor": "string",
    "page_size": 0,
    "quantity": 0
  },
  "sort": {
    "field_sort": "string",
    "sort": "string"
  }
}