Access Control API

Guest List API

Recupera a lista de convidados de uma sessão de evento. Aceita múltiplos filtros de busca e paginação por cursor.

GET/v1/events/:event_id/sessions/:session_id/guestlist

Headers obrigatórios

Parâmetro	Tipo	Descrição
`Authorization`Obrigatório	Bearer {token}	Token de acesso OAuth.
`X-Partner-ID`Obrigatório	string (UUID)	Identificador do parceiro, validado pelo gateway.

Parâmetros de URL

Todos são obrigatórios.

Parâmetro	Tipo
`event_id`	string (UUID)
`session_id`	string (UUID)

Parâmetros de query

Pelo menos um parâmetro de busca é obrigatório.

Parâmetro	Tipo	Descrição
`user_id`	string (UUID)	Filtra pelo usuário.
`document`	string	Documento do titular (ex.: CPF).
`email`	string	E-mail do titular.
`code`	string	Código de acesso.
`size`	int	Itens por página. Padrão 100, máximo 1000.
`cursor`	string	Cursor da próxima página (pagination.next).
`status`	string	valid \| cancelled \| refunded
`transferred`	boolean	Filtra códigos transferidos.
`updated_after`	string (RFC3339)	Atualizados após a data.
`updated_before`	string (RFC3339)	Atualizados antes da data.
`created_after`	string (RFC3339)	Criados após a data.
`created_before`	string (RFC3339)	Criados antes da data.
`code_id`	string (UUID)	UUID do código.
`ticket_id`	string (UUID)	UUID do ingresso.
`order_id`	string (UUID)	UUID do pedido.
`group_id`	string (UUID)	UUID do grupo de ingressos.
`code_type`	string	individual \| passport
`entrance_method`	string	qrcode \| biometrics \| manual
`has_rfc`	boolean	Possui biometria (RFC).

Exemplo de requisição

cURL · GET

curl -X GET \
"https://apigw-access-control.prod.ingresse.com/v1/events/:event_id/sessions/:session_id/guestlist\
?user_id=usr_789\
&document=12345678900\
&email=cliente%40exemplo.com\
&code=ABC123DEF\
&size=100\
&cursor=eyJwYWdlIjoyfQ%3D%3D\
&status=valid\
&transferred=true\
&updated_after=2025-10-01T00:00:00Z\
&updated_before=2025-10-27T23:59:59Z\
&created_after=2025-09-01T00:00:00Z\
&created_before=2025-10-15T23:59:59Z\
&code_id=11111111-1111-1111-1111-111111111111\
&ticket_id=22222222-2222-2222-2222-222222222222\
&order_id=33333333-3333-3333-3333-333333333333\
&group_id=44444444-4444-4444-4444-444444444444\
&code_type=individual\
&entrance_method=qrcode\
&has_rfc=true" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {token}" \
  -H "X-Partner-ID: {partner_UUID}"

Respostas

Status	Descrição
200OK	Lista retornada com sucesso.
400Bad Request	Filtros ausentes ou inválidos.
401Unauthorized	Token ausente ou inválido.
403Forbidden	X-Partner-ID inválido.
404Not Found	Evento ou sessão inexistente.
429Too Many Requests	Rate limit excedido (Retry-After).

Exemplo de resposta

JSON

{
  "data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000000",
      "code": "ABC123DEF",
      "external_id": "ext-9087",
      "type": "individual",
      "status": "active",
      "order_id": "33333333-3333-3333-3333-333333333333",
      "user_id": "usr_789",
      "event_id": "evt_123",
      "ticket_id": "22222222-2222-2222-2222-222222222222",
      "can_transfer": true,
      "owner_id": "own_555",
      "ownership": "owner",
      "user": {
        "id": "usr_789",
        "name": "Maria Silva",
        "document": "12345678900",
        "document_type": "cpf",
        "phone": "+5511999990000",
        "email": "[email protected]"
      },
      "owner": {
        "id": "own_555",
        "name": "Maria Silva",
        "document": "12345678900",
        "document_type": "cpf",
        "phone": "+5511999990000",
        "email": "[email protected]"
      },
      "event": {
        "id": "evt_123",
        "external_id": "ext-evt-1",
        "name": "Show de Verão",
        "description": "Edição 2025"
      },
      "ticket": {
        "id": "22222222-2222-2222-2222-222222222222",
        "external_id": "ext-tkt-1",
        "group_id": "44444444-4444-4444-4444-444444444444",
        "name": "Pista",
        "allotment": "lote-1",
        "price": 15000,
        "transferable": true,
        "holder_type": "nominal",
        "order": 1,
        "group": {
          "id": "44444444-4444-4444-4444-444444444444",
          "name": "Pista",
          "entrance_name": "Portão A",
          "entrance_method": "qrcode",
          "entrance_mapping": "gate-a"
        },
        "event_dates": [
          { "id": "ed_1", "external_id": "ext-ed-1", "date": "2025-12-20T22:00:00Z" }
        ]
      },
      "product": {
        "id": "prd_1",
        "name": "Combo Bebida",
        "sku": "SKU-001",
        "price": 2500,
        "image_url": "https://cdn.exemplo.com/p.png",
        "status": "active"
      },
      "attributes": {},
      "entrances": [
        { "id": "ent_1", "type": "checkin", "date": "2025-12-20T22:15:00Z" }
      ],
      "created_at": "2025-09-01T12:00:00Z",
      "updated_at": "2025-10-15T08:30:00Z"
    }
  ],
  "pagination": {
    "previous": null,
    "next": "eyJwYWdlIjoyfQ=="
  }
}

Paginação

Repasse o valor de pagination.next no parâmetro cursor para obter a próxima página, até que next seja null. O limite padrão é de 100 requisições/minuto por parceiro — veja Convenções da API.

Campos de resposta

Cada item de data representa um código de acesso. Os campos abaixo descrevem o objeto completo retornado.

Parâmetro	Tipo	Descrição
`id`	string (UUID)	UUID do código.
`code`	string	Código de acesso.
`external_id`	string	Identificador externo.
`type`	string	individual \| passport
`status`	string	active \| cancelled \| refunded
`order_id`	string (UUID)	UUID do pedido.
`user_id`	string (UUID)	UUID do usuário.
`event_id`	string (UUID)	UUID do evento.
`ticket_id`	string (UUID)	UUID do ingresso.
`can_transfer`	boolean	Indica se pode ser transferido.
`owner_id`	string (UUID)	UUID do titular.
`ownership`	string	owner \| dependent \| other
`user`	object	Dados do usuário (ver abaixo).
`owner`	object	Dados do titular (mesma estrutura de user).
`event`	object	Dados do evento (ver abaixo).
`ticket`	object	Dados do ingresso (ver abaixo).
`product`	object	Produto associado (ver abaixo).
`attributes`	object	Atributos adicionais (chave-valor).
`entrances`	array	Registros de entrada (ver abaixo).
`created_at`	string (RFC3339)	Data de criação.
`updated_at`	string (RFC3339)	Data da última atualização.

Objeto user / owner

Parâmetro	Tipo
`id`	string (UUID)
`name`	string
`document`	string
`document_type`	string
`phone`	string
`email`	string

Objeto event

Parâmetro	Tipo
`id`	string (UUID)
`external_id`	string
`name`	string
`description`	string

Objeto ticket

Parâmetro	Tipo	Descrição
`id`	string (UUID)
`external_id`	string
`group_id`	string (UUID)
`name`	string
`allotment`	string	Lote.
`price`	int	Preço em centavos.
`transferable`	boolean
`holder_type`	string
`order`	int
`group`	object	Dados do grupo (ver abaixo).
`event_dates`	array	Datas do evento (ver abaixo).

Objeto ticket.group

Parâmetro	Tipo
`id`	string (UUID)
`name`	string
`entrance_name`	string
`entrance_method`	string
`entrance_mapping`	string

Objeto ticket.event_dates[]

Parâmetro	Tipo
`id`	string (UUID)
`external_id`	string
`date`	string (RFC3339)

Objeto product

Parâmetro	Tipo	Descrição
`id`	string (UUID)
`name`	string
`sku`	string
`price`	int	Preço em centavos.
`image_url`	string
`status`	string

Objeto entrances[]

Parâmetro	Tipo	Descrição
`id`	string (UUID)
`type`	string	checkin \| checkout
`date`	string (RFC3339)

Objeto pagination

Parâmetro	Tipo	Descrição
`previous`	string \| null	Cursor para a página anterior.
`next`	string \| null	Cursor para a próxima página.