logo
redocly logoAPI docs by Redocly

Sympla API (v1.5.1)

Terms of Service

Introdução

Bem-vindo à API pública da Sympla!

A API da Sympla é a interface pública de acesso a dados da plataforma Sympla. Através dela é possível obter informações relacionadas aos eventos criados por você, como ingressos, pedidos e participantes.

A API disponibiliza endpoints com respostas em formato JSON, implementados conforme os princípios da arquitetura REST, garantindo integração segura, eficiente e de fácil consumo. O acesso aos dados é restrito aos eventos do próprio cliente, sendo necessária autenticação prévia para utilização dos recursos. Em conformidade com as boas práticas de design de APIs, campos cujo valor seja null são omitidos das respostas por padrão, de forma a otimizar a transferência de dados e evitar informações irrelevantes. Contudo, todos os endpoints oferecem suporte ao parâmetro FIELDS, que pode ser informado via querystring para especificação explícita dos atributos a serem incluídos na resposta. Quando esse parâmetro é utilizado, os campos com valor null também serão retornados, garantindo maior controle sobre a estrutura da resposta.

Neste documento você encontrará a referência técnica de como acessar todos os serviços disponíveis da API.

Autenticação

Para executar requisições válidas à Sympla API é necessário uma chave de acesso (token) associada ao seu usuário na plataforma. Este token deverá assinar todas as requisições enviadas à API.

Para gerar a chave de acesso é preciso logar na plataforma Sympla, acessar o menu "Minha Conta" (a partir do nome do seu usuário) e navegar até a aba "Integrações".

Autenticação

Nesta página, basta informar um nome identificando o token e clicar em "Criar chave de acesso". Você poderá gerar mais de uma credencial de acesso conforme a sua necessidade.

ApiKeyAuth

Security Scheme Type: API Key
Header parameter name: s_token

Eventos

Esta API fornece acesso às informações de eventos criados na plataforma Sympla, exclusivamente aqueles vinculados ao usuário proprietário do token.

A API também permite a personalização dos resultados, possibilitando filtrar eventos dentro de uma janela de data ou restringir quais campos são relevantes e devem ser exibidos no retorno, como apenas nome do evento e descrição.

Listar eventos

Retorna os eventos criados pelo organizador.

query Parameters
from
string

Data no formato YYYY-MM-DD HH:mm:ss. Para filtrar todos os eventos que começam a partir da data informada

published
boolean
Default: true

Por padrão somente os eventos publicados serão listados.

page_size
integer
Default: 100

Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200.

page
integer
Default: 1

Número da página dos resultados.

field_sort
string
Default: "start_date"

Permite que os resultados sejam ordenados (apenas os campos id, start_date, end_date e name)

sort
string
Default: "ASC"
Enum: "ASC" "DESC"
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
Array of objects (Events)
object (Sort)
object (Pagination)
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Request samples 

curl --request GET \
--url 'https://api.sympla.com.br/public/v1.5.1/events' \
--header 's_token: <TOKEN_USER>'

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "b1",
      • "reference_id": 1,
      • "start_date": "2018-09-21 22:00:00",
      • "end_date": "2018-09-22 12:00:01",
      • "name": "Workshop da Sympla",
      • "detail": "<b>Ola esse é um evento da Sympla</b><br><h1>Sejam todos bem-vindo</h1>",
      • "private_event": 1,
      • "published": 1,
      • "cancelled": 0,
      • "image": "https://www.sympla.com.br/images/public/logo-sympla-new-blue@3x.png",
      • "url": "https://www.sympla.com.br/festa-800__332504",
      • "address": {
        • "name": "Loja Contempo",
        • "address": "Rua Fernandes Tourinho",
        • "address_num": "AB45ER78",
        • "address_alt": "10º Andar",
        • "neighborhood": "Funcionários",
        • "city": "Belo Horizonte",
        • "state": "MG",
        • "zip_code": "31112-000",
        • "country": "BR",
        • "lon": "-12.3456789",
        • "lat": "-12.3456789"
        },
      • "host": {
        • "name": "Sympla Eventos",
        • "description": "Área responsável pela organização de eventos da empresa Sympla"
        },
      • "category_prim": {
        • "name": "encontro-networking"
        },
      • "category_sec": {
        • "name": "encontro-festa"
        }
      }
    ],
  • "sort": {
    • "field_sort": "id",
    • "sort": "ASC"
    },
  • "pagination": {
    • "has_next": true,
    • "has_prev": false,
    • "quantity": 10,
    • "offset": 1,
    • "page": 1,
    • "page_size": 100
    }
}

Listar evento por identificador

Retorna o evento correspondente ao identificador informado

path Parameters
event_id
required
integer <int32>

Identificador único do evento

query Parameters
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
object (Events)
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Request samples 

curl --request GET \
--url 'https://api.sympla.com.br/public/v1.5.1/events/123456' \
--header 's_token: <TOKEN_USER>'

Response samples

Content type
application/json
{
  • "data": {
    • "id": "b1",
    • "reference_id": 1,
    • "start_date": "2018-09-21 22:00:00",
    • "end_date": "2018-09-22 12:00:01",
    • "name": "Workshop da Sympla",
    • "detail": "<b>Ola esse é um evento da Sympla</b><br><h1>Sejam todos bem-vindo</h1>",
    • "private_event": 1,
    • "published": 1,
    • "cancelled": 0,
    • "image": "https://www.sympla.com.br/images/public/logo-sympla-new-blue@3x.png",
    • "url": "https://www.sympla.com.br/festa-800__332504",
    • "address": {
      • "name": "Loja Contempo",
      • "address": "Rua Fernandes Tourinho",
      • "address_num": "AB45ER78",
      • "address_alt": "10º Andar",
      • "neighborhood": "Funcionários",
      • "city": "Belo Horizonte",
      • "state": "MG",
      • "zip_code": "31112-000",
      • "country": "BR",
      • "lon": "-12.3456789",
      • "lat": "-12.3456789"
      },
    • "host": {
      • "name": "Sympla Eventos",
      • "description": "Área responsável pela organização de eventos da empresa Sympla"
      },
    • "category_prim": {
      • "name": "encontro-networking"
      },
    • "category_sec": {
      • "name": "encontro-festa"
      }
    }
}

Listar apresentações de um evento

Retorna lista de apresentações criadas pelo organizador para o evento.

path Parameters
event_id
required
string

Identificador único do evento

query Parameters
from
string

Data no formato YYYY-MM-DD HH:mm:ss. Para filtrar todas as apresentações que começam a partir da data informada

published
boolean
Default: true

Por padrão somente as apresentações publicadas serão listadas.

page_size
integer
Default: 100

Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200.

page
integer
Default: 1

Número da página dos resultados.

field_sort
string
Default: "start_date"

Permite que os resultados sejam ordenados (apenas start_date)

sort
string
Default: "ASC"
Enum: "ASC" "DESC"
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

filter_online_sector
boolean
Default: true

Filtrar setores com venda online disponível.

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
Array of objects (Presentations)
object (Sort)
object (Pagination)
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Request samples 

curl --request GET \
--url 'https://api.sympla.com.br/public/v1.5.1/events/<event_id>/presentations' \
--header 's_token: <TOKEN_USER>'

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 1,
      • "event_id": "b1",
      • "reference_id": 1,
      • "start_date": "2018-09-21 22:00:00",
      • "name": "Workshop da Sympla",
      • "detail": "<b>Ola esse é um evento da Sympla</b><br><h1>Sejam todos bem-vindo</h1>",
      • "private_event": 1,
      • "private_presentation": 1,
      • "event_published": 1,
      • "event_cancelled": 0,
      • "presentation_published": 1,
      • "presentation_cancelled": 0,
      • "image": "https://www.sympla.com.br/images/public/logo-sympla-new-blue@3x.png",
      • "url": "https://bileto.sympla.com.br/event/123456/d/123456",
      • "address": {
        • "name": "Loja Contempo",
        • "address": "Rua Fernandes Tourinho",
        • "address_num": "AB45ER78",
        • "address_alt": "10º Andar",
        • "neighborhood": "Funcionários",
        • "city": "Belo Horizonte",
        • "state": "MG",
        • "zip_code": "31112-000",
        • "country": "BR",
        • "lon": "-12.3456789",
        • "lat": "-12.3456789"
        },
      • "host": {
        • "name": "Sympla Eventos",
        • "description": "Área responsável pela organização de eventos da empresa Sympla"
        },
      • "category_prim": {
        • "name": "encontro-networking"
        },
      • "category_sec": {
        • "name": "encontro-festa"
        },
      • "sectors": [
        • {
          • "id": 1,
          • "name": "Plateia Superior",
          • "has_online_sale_available": true
          }
        ]
      }
    ],
  • "sort": {
    • "field_sort": "id",
    • "sort": "ASC"
    },
  • "pagination": {
    • "has_next": true,
    • "has_prev": false,
    • "quantity": 10,
    • "offset": 1,
    • "page": 1,
    • "page_size": 100
    }
}

Listar apresentações por identificador

Retorna lista de apresentações criadas pelo organizador para o evento.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

presentation_id
required
integer <int32>

Identificador único da apresentação

query Parameters
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
Array of objects (Presentations)
object (Sort)
object (Pagination)
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Request samples 

curl --request GET \
--url 'https://api.sympla.com.br/public/v1.5.1/events/<event_id>/presentations/<presentation_id>' \
--header 's_token: <TOKEN_USER>'

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 1,
      • "event_id": "b1",
      • "reference_id": 1,
      • "start_date": "2018-09-21 22:00:00",
      • "name": "Workshop da Sympla",
      • "detail": "<b>Ola esse é um evento da Sympla</b><br><h1>Sejam todos bem-vindo</h1>",
      • "private_event": 1,
      • "private_presentation": 1,
      • "event_published": 1,
      • "event_cancelled": 0,
      • "presentation_published": 1,
      • "presentation_cancelled": 0,
      • "image": "https://www.sympla.com.br/images/public/logo-sympla-new-blue@3x.png",
      • "url": "https://bileto.sympla.com.br/event/123456/d/123456",
      • "address": {
        • "name": "Loja Contempo",
        • "address": "Rua Fernandes Tourinho",
        • "address_num": "AB45ER78",
        • "address_alt": "10º Andar",
        • "neighborhood": "Funcionários",
        • "city": "Belo Horizonte",
        • "state": "MG",
        • "zip_code": "31112-000",
        • "country": "BR",
        • "lon": "-12.3456789",
        • "lat": "-12.3456789"
        },
      • "host": {
        • "name": "Sympla Eventos",
        • "description": "Área responsável pela organização de eventos da empresa Sympla"
        },
      • "category_prim": {
        • "name": "encontro-networking"
        },
      • "category_sec": {
        • "name": "encontro-festa"
        },
      • "sectors": [
        • {
          • "id": 1,
          • "name": "Plateia Superior",
          • "has_online_sale_available": true
          }
        ]
      }
    ],
  • "sort": {
    • "field_sort": "id",
    • "sort": "ASC"
    },
  • "pagination": {
    • "has_next": true,
    • "has_prev": false,
    • "quantity": 10,
    • "offset": 1,
    • "page": 1,
    • "page_size": 100
    }
}

Pedidos

A API de pedidos proporciona informações de compras (ou inscrições, caso o evento seja gratuito) como dados de ingressos, participantes e pagamento. Um pedido pode conter mais de um ingresso e um ingresso está sempre associado a um único participante.

É possível consultar os dados para emissão da nota fiscal, caso o evento esteja configurado para solicitar estas informações durante o processo de compra (saiba mais).

Listar pedidos por evento

Retorna os pedidos de um determinado evento.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

query Parameters
status
boolean
Default: false
Enum: true false

Retorna todos os pedidos com qualquer status.
true: Retorna os pedidos de todos os status;
false: Retorna apenas os pedidos com status aprovado.

buyer_email
string

Email do comprador

page_size
integer
Default: 100

Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200.

page
integer
Default: 1

Número da página dos resultados.

field_sort
string

Permite que os resultados sejam ordenados. (apenas os campos id, order_date, updated_date, approved_date)

sort
string
Default: "ASC"
Enum: "ASC" "DESC"
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

timezone
string
Default: "America/Sao_Paulo"

Especifica em que timezone os campos data/hora devem ser retornado.

from
string

Especifica a partir de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 00:00:00

to
string

Especifica até de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 23:59:59

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
Array of objects (Orders)
object (Sort)
object
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "Q080KEE",
      • "event_id": "b1234",
      • "order_date": "2018-10-21 10:12:23",
      • "order_status": "APPROVED",
      • "updated_date": "2018-10-10 23:34:21",
      • "approved_date": "2018-10-10 23:34:21",
      • "discount_code": "10,00% - desconto10",
      • "transaction_type": "BOLETO_BANCARIO",
      • "order_total_sale_price": 12.5,
      • "order_total_net_value": 10,
      • "buyer_first_name": "Joaquim",
      • "buyer_last_name": "Lopes",
      • "buyer_email": "meuemail@sympla.com.br",
      • "invoice_info": {
        • "doc_type": "CPF",
        • "doc_number": "142.536.789-55",
        • "client_name": "Joaquim",
        • "address_zip_code": "31112-000",
        • "address_street": "Rua Fernandes Tourinho",
        • "address_street_number": "147",
        • "address_street2": "10º Andar",
        • "address_neighborhood": "Funcionários",
        • "address_city": "Belo Horizonte",
        • "address_state": "MG",
        • "mei": 0
        },
      • "utm": {
        • "utm_source": "facebook",
        • "utm_medium": "cpc",
        • "utm_campaign": "nome_da_campanha",
        • "utm_term": "campanha",
        • "utm_content": "banner",
        • "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36",
        • "referrer": "campanha.site.com"
        }
      }
    ],
  • "sort": {
    • "field_sort": "id",
    • "sort": "ASC"
    },
  • "pagination": {
    • "has_next": true,
    • "has_prev": false,
    • "quantity": 10,
    • "offset": 1,
    • "page": 1,
    • "page_size": 100,
    • "total_records": 15,
    • "total_page": 2
    }
}

Listar pedidos por apresentação de evento

Retorna os pedidos de uma determinada apresentação de evento.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

presentation_id
required
integer <int32>

Identificador único da apresentação

query Parameters
status
boolean
Default: false
Enum: true false

Retorna todos os pedidos com qualquer status.
true: Retorna os pedidos de todos os status;
false: Retorna apenas os pedidos com status aprovado.

buyer_email
string

Email do comprador

page_size
integer
Default: 100

Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200.

page
integer
Default: 1

Número da página dos resultados.

field_sort
string

Permite que os resultados sejam ordenados. (apenas os campos id, order_date, updated_date, approved_date)

sort
string
Default: "ASC"
Enum: "ASC" "DESC"
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

timezone
string
Default: "America/Sao_Paulo"

Especifica em que timezone os campos data/hora devem ser retornado.

from
string

Especifica a partir de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 00:00:00

to
string

Especifica até de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 23:59:59

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
Array of objects (Orders)
object (Sort)
object
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": "Q080KEE",
      • "event_id": "b1234",
      • "order_date": "2018-10-21 10:12:23",
      • "order_status": "APPROVED",
      • "updated_date": "2018-10-10 23:34:21",
      • "approved_date": "2018-10-10 23:34:21",
      • "discount_code": "10,00% - desconto10",
      • "transaction_type": "BOLETO_BANCARIO",
      • "order_total_sale_price": 12.5,
      • "order_total_net_value": 10,
      • "buyer_first_name": "Joaquim",
      • "buyer_last_name": "Lopes",
      • "buyer_email": "meuemail@sympla.com.br",
      • "invoice_info": {
        • "doc_type": "CPF",
        • "doc_number": "142.536.789-55",
        • "client_name": "Joaquim",
        • "address_zip_code": "31112-000",
        • "address_street": "Rua Fernandes Tourinho",
        • "address_street_number": "147",
        • "address_street2": "10º Andar",
        • "address_neighborhood": "Funcionários",
        • "address_city": "Belo Horizonte",
        • "address_state": "MG",
        • "mei": 0
        },
      • "utm": {
        • "utm_source": "facebook",
        • "utm_medium": "cpc",
        • "utm_campaign": "nome_da_campanha",
        • "utm_term": "campanha",
        • "utm_content": "banner",
        • "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36",
        • "referrer": "campanha.site.com"
        }
      }
    ],
  • "sort": {
    • "field_sort": "id",
    • "sort": "ASC"
    },
  • "pagination": {
    • "has_next": true,
    • "has_prev": false,
    • "quantity": 10,
    • "offset": 1,
    • "page": 1,
    • "page_size": 100,
    • "total_records": 15,
    • "total_page": 2
    }
}

Listar pedido por identificador

Retorna o pedido correspondente ao identificador informado.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

order_id
required
string

Identificador único do pedido

query Parameters
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

timezone
string
Default: "America/Sao_Paulo"

Especifica em que timezone os campos data/hora devem ser retornado.

from
string

Especifica a partir de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 00:00:00

to
string

Especifica até de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 23:59:59

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
object (Orders)
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": {
    • "id": "Q080KEE",
    • "event_id": "b1234",
    • "order_date": "2018-10-21 10:12:23",
    • "order_status": "APPROVED",
    • "updated_date": "2018-10-10 23:34:21",
    • "approved_date": "2018-10-10 23:34:21",
    • "discount_code": "10,00% - desconto10",
    • "transaction_type": "BOLETO_BANCARIO",
    • "order_total_sale_price": 12.5,
    • "order_total_net_value": 10,
    • "buyer_first_name": "Joaquim",
    • "buyer_last_name": "Lopes",
    • "buyer_email": "meuemail@sympla.com.br",
    • "invoice_info": {
      • "doc_type": "CPF",
      • "doc_number": "142.536.789-55",
      • "client_name": "Joaquim",
      • "address_zip_code": "31112-000",
      • "address_street": "Rua Fernandes Tourinho",
      • "address_street_number": "147",
      • "address_street2": "10º Andar",
      • "address_neighborhood": "Funcionários",
      • "address_city": "Belo Horizonte",
      • "address_state": "MG",
      • "mei": 0
      },
    • "utm": {
      • "utm_source": "facebook",
      • "utm_medium": "cpc",
      • "utm_campaign": "nome_da_campanha",
      • "utm_term": "campanha",
      • "utm_content": "banner",
      • "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/115.0.0.0 Safari/537.36",
      • "referrer": "campanha.site.com"
      }
    }
}

Listar participantes por pedido

Retorna o(s) participante(s) contido(s) em um determinado pedido.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

order_id
required
string

Identificador único do pedido

query Parameters
cancelled
boolean

Especifica se deve incluir pedidos cancelados na busca.

page_size
integer
Default: 100

Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200.

page
integer
Default: 1

Número da página dos resultados.

field_sort
string

Permite que os resultados sejam ordenados. (apenas os campos id, order_id, order_date, order_updated_date, order_approved_date, check_in_date, ticket_number, ticket_num_qr_code)

sort
string
Default: "ASC"
Enum: "ASC" "DESC"
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

from
string

Especifica a partir de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 00:00:00

to
string

Especifica até de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 23:59:59

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
Array of objects
object (Sort)
object (Pagination)
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 102345,
      • "event_id": "b1234",
      • "order_id": "BC1BA1",
      • "order_status": "A",
      • "order_date": "2018-10-21 10:12:23",
      • "order_updated_date": "2018-10-21 15:12:23",
      • "order_approved_date": "2018-10-21 11:34:21",
      • "order_discount": "10,00% - desconto10",
      • "first_name": "Joaquim",
      • "last_name": "Lopes",
      • "email": "meuemail@sympla.com.br",
      • "ticket_number": "QHWA-1Q-3G0J",
      • "ticket_num_qr_code": "QHWA1Q3G0J",
      • "ticket_name": "VIP",
      • "sector_name": "2o Pavimento",
      • "marked_place_name": "A44",
      • "access_information": "Portão 1'",
      • "pdv_user": "meuemail@sympla.com.br",
      • "ticket_sale_price": 123.5,
      • "checkin": {
        • "id": 1,
        • "check_in": true,
        • "check_in_date": "2018-09-10T10:21:10-03:00"
        },
      • "custom_form": {
        • "id": 1,
        • "name": "CPF",
        • "value": "142.536.789-55"
        },
      • "ticket_created_at": "2018-10-21 10:12:23",
      • "ticket_updated_at": "2018-10-21 15:12:23",
      • "presentation_id": 54747
      }
    ],
  • "sort": {
    • "field_sort": "id",
    • "sort": "ASC"
    },
  • "pagination": {
    • "has_next": true,
    • "has_prev": false,
    • "quantity": 10,
    • "offset": 1,
    • "page": 1,
    • "page_size": 100
    }
}

Participantes

Com a API de participantes é possível obter informações relativas aos titulares dos ingressos do evento, como nome, e-mail e realizar check-in de um participante.

A API também retornará informações obtidas via campos customizados, caso tenham sido adicionados no formulário de inscrição do evento.

Listar participantes por evento

Retorna os participantes de um determinado evento.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

query Parameters
cancelled_filter
string
Default: "none"
Enum: "none" "include" "only"

Permite retornar participantes com status do pedido cancelado.
include: Retorna participantes dos pedidos com status cancelado e aprovado;
only: Retorna participantes apenas dos pedidos com status cancelado.
none: Retorna participantes apenas dos pedidos com status aprovado.

ticket_number
string

Código escrito no ingresso. Este atributo não deverá ser utilizado com identificador único do ingresso, pois em caso de troca de titularidade esse código irá mudar..

participant_email
string

Filtra o resultado de participantes conforme o e-mail informado. Ao usar em combinação com o ticket_number, deverá trazer somente os participantes com o e-mail informado vinculados ao ticket preenchido.

page_size
integer
Default: 100

Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200.

page
integer
Default: 1

Número da página dos resultados.

field_sort
string

Permite que os resultados sejam ordenados. (apenas os campos id, order_id, order_date, order_updated_date, order_approved_date, check_in_date, ticket_number, ticket_num_qr_code)

sort
string
Default: "ASC"
Enum: "ASC" "DESC"
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

from
string

Especifica a partir de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 00:00:00

to
string

Especifica até de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 23:59:59

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
Array of objects
object (Sort)
object
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 102345,
      • "event_id": "b1234",
      • "order_id": "BC1BA1",
      • "order_status": "A",
      • "order_date": "2018-10-21 10:12:23",
      • "order_updated_date": "2018-10-21 15:12:23",
      • "order_approved_date": "2018-10-21 11:34:21",
      • "order_discount": "10,00% - desconto10",
      • "first_name": "Joaquim",
      • "last_name": "Lopes",
      • "email": "meuemail@sympla.com.br",
      • "ticket_number": "QHWA-1Q-3G0J",
      • "ticket_num_qr_code": "QHWA1Q3G0J",
      • "ticket_name": "VIP",
      • "sector_name": "2o Pavimento",
      • "marked_place_name": "A44",
      • "access_information": "Portão 1'",
      • "pdv_user": "meuemail@sympla.com.br",
      • "ticket_sale_price": 123.5,
      • "checkin": {
        • "id": 1,
        • "check_in": true,
        • "check_in_date": "2018-09-10T10:21:10-03:00"
        },
      • "custom_form": {
        • "id": 1,
        • "name": "CPF",
        • "value": "142.536.789-55"
        },
      • "ticket_created_at": "2018-10-21 10:12:23",
      • "ticket_updated_at": "2018-10-21 15:12:23",
      • "presentation_id": 54747
      }
    ],
  • "sort": {
    • "field_sort": "id",
    • "sort": "ASC"
    },
  • "pagination": {
    • "has_next": true,
    • "has_prev": false,
    • "quantity": 10,
    • "offset": 1,
    • "page": 1,
    • "page_size": 100,
    • "total_records": 15,
    • "total_page": 2
    }
}

Listar participantes por apresentação de evento

Retorna os participantes de uma determinada apresentação de evento.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

presentation_id
required
integer <int32>

Identificador único da apresentação

query Parameters
cancelled_filter
string
Default: "none"
Enum: "none" "include" "only"

Permite retornar participantes com status do pedido cancelado.
include: Retorna participantes dos pedidos com status cancelado e aprovado;
only: Retorna participantes apenas dos pedidos com status cancelado.
none: Retorna participantes apenas dos pedidos com status aprovado.

ticket_number
string

Código escrito no ingresso. Este atributo não deverá ser utilizado com identificador único do ingresso, pois em caso de troca de titularidade esse código irá mudar..

participant_email
string

Filtra o resultado de participantes conforme o e-mail informado. Ao usar em combinação com o ticket_number, deverá trazer somente os participantes com o e-mail informado vinculados ao ticket preenchido.

page_size
integer
Default: 100

Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200.

page
integer
Default: 1

Número da página dos resultados.

field_sort
string

Permite que os resultados sejam ordenados. (apenas os campos id, order_id, order_date, order_updated_date, order_approved_date, check_in_date, ticket_number, ticket_num_qr_code)

sort
string
Default: "ASC"
Enum: "ASC" "DESC"
fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

from
string

Especifica a partir de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 00:00:00

to
string

Especifica até de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 23:59:59

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
Array of objects
object (Sort)
object
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "id": 102345,
      • "event_id": "b1234",
      • "order_id": "BC1BA1",
      • "order_status": "A",
      • "order_date": "2018-10-21 10:12:23",
      • "order_updated_date": "2018-10-21 15:12:23",
      • "order_approved_date": "2018-10-21 11:34:21",
      • "order_discount": "10,00% - desconto10",
      • "first_name": "Joaquim",
      • "last_name": "Lopes",
      • "email": "meuemail@sympla.com.br",
      • "ticket_number": "QHWA-1Q-3G0J",
      • "ticket_num_qr_code": "QHWA1Q3G0J",
      • "ticket_name": "VIP",
      • "sector_name": "2o Pavimento",
      • "marked_place_name": "A44",
      • "access_information": "Portão 1'",
      • "pdv_user": "meuemail@sympla.com.br",
      • "ticket_sale_price": 123.5,
      • "checkin": {
        • "id": 1,
        • "check_in": true,
        • "check_in_date": "2018-09-10T10:21:10-03:00"
        },
      • "custom_form": {
        • "id": 1,
        • "name": "CPF",
        • "value": "142.536.789-55"
        },
      • "ticket_created_at": "2018-10-21 10:12:23",
      • "ticket_updated_at": "2018-10-21 15:12:23",
      • "presentation_id": 54747
      }
    ],
  • "sort": {
    • "field_sort": "id",
    • "sort": "ASC"
    },
  • "pagination": {
    • "has_next": true,
    • "has_prev": false,
    • "quantity": 10,
    • "offset": 1,
    • "page": 1,
    • "page_size": 100,
    • "total_records": 15,
    • "total_page": 2
    }
}

Listar participante por id do ingresso

Retorna o participante correspondente ao ingresso informado.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

participant_id
required
integer <int32>

Identificador único do ingresso

query Parameters
cancelled_filter
string
Default: "none"
Enum: "none" "include" "only"

Permite retornar participantes com status do pedido cancelado.
include: Retorna participantes dos pedidos com status cancelado e aprovado;
only: Retorna participantes apenas dos pedidos com status cancelado.
none: Retorna participantes apenas dos pedidos com status aprovado.

fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

from
string

Especifica a partir de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 00:00:00

to
string

Especifica até de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 23:59:59

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
object
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 102345,
    • "event_id": "b1234",
    • "order_id": "BC1BA1",
    • "order_status": "A",
    • "order_date": "2018-10-21 10:12:23",
    • "order_updated_date": "2018-10-21 15:12:23",
    • "order_approved_date": "2018-10-21 11:34:21",
    • "order_discount": "10,00% - desconto10",
    • "first_name": "Joaquim",
    • "last_name": "Lopes",
    • "email": "meuemail@sympla.com.br",
    • "ticket_number": "QHWA-1Q-3G0J",
    • "ticket_num_qr_code": "QHWA1Q3G0J",
    • "ticket_name": "VIP",
    • "sector_name": "2o Pavimento",
    • "marked_place_name": "A44",
    • "access_information": "Portão 1'",
    • "pdv_user": "meuemail@sympla.com.br",
    • "ticket_sale_price": 123.5,
    • "checkin": {
      • "id": 1,
      • "check_in": true,
      • "check_in_date": "2018-09-10T10:21:10-03:00"
      },
    • "custom_form": {
      • "id": 1,
      • "name": "CPF",
      • "value": "142.536.789-55"
      },
    • "ticket_created_at": "2018-10-21 10:12:23",
    • "ticket_updated_at": "2018-10-21 15:12:23",
    • "presentation_id": 54747
    }
}

Listar participante por número de ingresso

Retorna o participante correspondente ao ingresso informado.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

ticket_number
required
string

Número do ingresso

query Parameters
cancelled_filter
string
Default: "none"
Enum: "none" "include" "only"

Permite retornar participantes com status do pedido cancelado.
include: Retorna participantes dos pedidos com status cancelado e aprovado;
only: Retorna participantes apenas dos pedidos com status cancelado.
none: Retorna participantes apenas dos pedidos com status aprovado.

fields
string

Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ","

from
string

Especifica a partir de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 00:00:00

to
string

Especifica até de que data as informações de compras, ou inscrições caso o evento seja gratuito, deve ser retornados. A data deve está no formato YYYY-MM-DD. A hora é opcional e se informada deve está no formato HH:mm:ss. Caso a hora não seja informado será considerado 23:59:59

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
object
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 102345,
    • "event_id": "b1234",
    • "order_id": "BC1BA1",
    • "order_status": "A",
    • "order_date": "2018-10-21 10:12:23",
    • "order_updated_date": "2018-10-21 15:12:23",
    • "order_approved_date": "2018-10-21 11:34:21",
    • "order_discount": "10,00% - desconto10",
    • "first_name": "Joaquim",
    • "last_name": "Lopes",
    • "email": "meuemail@sympla.com.br",
    • "ticket_number": "QHWA-1Q-3G0J",
    • "ticket_num_qr_code": "QHWA1Q3G0J",
    • "ticket_name": "VIP",
    • "sector_name": "2o Pavimento",
    • "marked_place_name": "A44",
    • "access_information": "Portão 1'",
    • "pdv_user": "meuemail@sympla.com.br",
    • "ticket_sale_price": 123.5,
    • "checkin": {
      • "id": 1,
      • "check_in": true,
      • "check_in_date": "2018-09-10T10:21:10-03:00"
      },
    • "custom_form": {
      • "id": 1,
      • "name": "CPF",
      • "value": "142.536.789-55"
      },
    • "ticket_created_at": "2018-10-21 10:12:23",
    • "ticket_updated_at": "2018-10-21 15:12:23",
    • "presentation_id": 54747
    }
}

Check-in

Com a API de checkin é possível realizar a validação do ingresso dos usuários de três maneiras.

  • Com o ID do ingresso também conhecido como ID do participante
  • Numero do ticket, podendo ser ticketNumber quando estamos falando de DIY ou scanneableCode quando estamos falando dos eventos Bileto.
  • E por fim, pelo QrCode gerado pelo App do cliente de forma dinâmica. Este terceiro modo usa um processo de assinatura dos ingressos, que serve como uma camada a mais de segurança.

Check-in por id do ingresso.

Realiza o check-in de um participante por id do ingresso.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

participant_id
required
integer

ID do ingresso

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
object (Participants)
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 102345,
    • "event_id": "b1234",
    • "order_id": "BC1BA1",
    • "order_status": "A",
    • "order_date": "2018-10-21 10:12:23",
    • "order_updated_date": "2018-10-21 15:12:23",
    • "order_approved_date": "2018-10-21 11:34:21",
    • "order_discount": "10,00% - desconto10",
    • "first_name": "Joaquim",
    • "last_name": "Lopes",
    • "email": "meuemail@sympla.com.br",
    • "ticket_number": "QHWA-1Q-3G0J",
    • "ticket_num_qr_code": "QHWA1Q3G0J",
    • "ticket_name": "VIP",
    • "sector_name": "2o Pavimento",
    • "marked_place_name": "A44",
    • "access_information": "Portão 1'",
    • "pdv_user": "meuemail@sympla.com.br",
    • "ticket_sale_price": 123.5,
    • "checkin": {
      • "id": 1,
      • "check_in": true,
      • "check_in_date": "2018-09-10T10:21:10-03:00"
      },
    • "custom_form": {
      • "id": 1,
      • "name": "CPF",
      • "value": "142.536.789-55"
      }
    }
}

Check-in por número do ingresso.

Realiza o check-in de um participante por número do ingresso.

path Parameters
event_id
required
integer <int32>

Identificador único do evento

ticket_number
required
string

Número do ingresso

header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Responses

Response Schema: application/json
object (Participants)
Response Schema: application/json
error
boolean (Parâmetro informando que existe um erro.)
code
integer <int32> (Código de erro)
message
string (Descrição do erro)

Response samples

Content type
application/json
{
  • "data": {
    • "id": 102345,
    • "event_id": "b1234",
    • "order_id": "BC1BA1",
    • "order_status": "A",
    • "order_date": "2018-10-21 10:12:23",
    • "order_updated_date": "2018-10-21 15:12:23",
    • "order_approved_date": "2018-10-21 11:34:21",
    • "order_discount": "10,00% - desconto10",
    • "first_name": "Joaquim",
    • "last_name": "Lopes",
    • "email": "meuemail@sympla.com.br",
    • "ticket_number": "QHWA-1Q-3G0J",
    • "ticket_num_qr_code": "QHWA1Q3G0J",
    • "ticket_name": "VIP",
    • "sector_name": "2o Pavimento",
    • "marked_place_name": "A44",
    • "access_information": "Portão 1'",
    • "pdv_user": "meuemail@sympla.com.br",
    • "ticket_sale_price": 123.5,
    • "checkin": {
      • "id": 1,
      • "check_in": true,
      • "check_in_date": "2018-09-10T10:21:10-03:00"
      },
    • "custom_form": {
      • "id": 1,
      • "name": "CPF",
      • "value": "142.536.789-55"
      }
    }
}

Check-in utilizando o QrCode.

Realiza o check-in, através do QrCode gerado pelo aplicativo da Sympla.

Importante

Para que você consiga realizar o check-in, você precisa ler o QrCode gerado pelo App do cliente e enviar os dados para a API da Sympla no formato JSON.

path Parameters
event_id
required
string

Identificador único do evento.

O event_id segue o padrão:

  • s para eventos da Sympla DIY
  • b para eventos da Sympla Bileto

O restante do identificador é composto pelo valor hexadecimal do ID do evento.

Exemplos:

  • s12E462 representa o evento com ID 1238114 na plataforma Sympla.
  • b5AFF9 representa o evento com ID 372729 na plataforma Bileto.
header Parameters
S_TOKEN
required
string

Chave de acesso da conta do Usuário

Request Body schema: application/json
required
itemId
string non-empty

Item ID, pode ser o ticketNumber ou scanneableCode

walletId
string <uuid>

Sympla WalletId

signature
string = 128 characters

Assinatura do ticket

timestamp
integer

Timestamp do QR Code | Unix Timestamps

version
integer

Versão do payload

Responses

Response Schema: application/json
object (Participants)

Request samples

Content type
application/json
{
  • "walletId": "3634e8b7-02f9-4356-a89e-e4ebbf1465c1",
  • "itemId": "TTD8QL4G87",
  • "signature": "0x4856640439763f233a8875ff8ccb20a885908157cda387b84ab172de9ca43c626427a2344ae6228324ce5b0307dd6b8e67156035c0bc87344ade7ea746d0bf991b",
  • "timestamp": 1729295849,
  • "version": 1
}

Response samples

Content type
application/json
{
  • "data": {
    • "id": 102345,
    • "event_id": "b1234",
    • "order_id": "BC1BA1",
    • "order_status": "A",
    • "order_date": "2018-10-21 10:12:23",
    • "order_updated_date": "2018-10-21 15:12:23",
    • "order_approved_date": "2018-10-21 11:34:21",
    • "order_discount": "10,00% - desconto10",
    • "first_name": "Joaquim",
    • "last_name": "Lopes",
    • "email": "meuemail@sympla.com.br",
    • "ticket_number": "QHWA-1Q-3G0J",
    • "ticket_num_qr_code": "QHWA1Q3G0J",
    • "ticket_name": "VIP",
    • "sector_name": "2o Pavimento",
    • "marked_place_name": "A44",
    • "access_information": "Portão 1'",
    • "pdv_user": "meuemail@sympla.com.br",
    • "ticket_sale_price": 123.5,
    • "checkin": {
      • "id": 1,
      • "check_in": true,
      • "check_in_date": "2018-09-10T10:21:10-03:00"
      },
    • "custom_form": {
      • "id": 1,
      • "name": "CPF",
      • "value": "142.536.789-55"
      }
    }
}