/sympla | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
sympla_get_affiliates | Listar afiliados por evento |
sympla_get_event | Listar evento por identificador |
sympla_get_events | Listar eventos |
sympla_get_order | Listar pedido de um evento por identificador |
sympla_get_orders | Listar pedidos por evento |
sympla_get_participant | Listar participante por id do ingresso |
sympla_get_participant_per_ticket_number | Listar participante por número de ingresso |
sympla_get_participants | Listar participantes por pedido |
sympla_get_participants_per_event | Listar participantes por evento |
sympla_post_check_in_participant_id | Check-in por id do ingresso. |
sympla_post_check_in_ticket_number | Check-in por número do ingresso. |
sympla_get_affiliates
Listar afiliados por evento Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
}
},
"required": [
"PCID",
"event_id"
]
}
sympla_get_event
Listar evento por identificador Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
fields | string | No | — | Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ”,“ |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"fields": {
"type": "string",
"description": "Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por \",\""
}
},
"required": [
"PCID",
"event_id"
]
}
sympla_get_events
Listar eventos Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from | string | No | — | Data no formato YYYY-MM-DD HH:mm:ss. Para filtrar todos os eventos que começam a partir da data informada |
published | string | No | — | Por padrão somente os eventos publicados serão listados. |
page_size | integer | No | — | Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200. |
page | integer | No | — | Especifica qual página o usuário deseja visualizar. Mínimo 1. |
field_sort | string | No | — | Permite que os resultados sejam ordenados. |
sort | string | No | — | Permite que os resultados sejam ordenados. |
fields | string | No | — | Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ”,“ |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"from": {
"type": "string",
"description": "Data no formato YYYY-MM-DD HH:mm:ss. Para filtrar todos os eventos que começam a partir da data informada"
},
"published": {
"type": "string",
"description": "Por padrão somente os eventos publicados serão listados."
},
"page_size": {
"type": "integer",
"description": "Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200."
},
"page": {
"type": "integer",
"description": "Especifica qual página o usuário deseja visualizar. Mínimo 1."
},
"field_sort": {
"type": "string",
"description": "Permite que os resultados sejam ordenados."
},
"sort": {
"type": "string",
"description": "Permite que os resultados sejam ordenados.",
"enum": [
"ASC",
"DESC"
]
},
"fields": {
"type": "string",
"description": "Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por \",\""
}
},
"required": [
"PCID"
]
}
sympla_get_order
Listar pedido de um evento por identificador Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
order_id | integer | Yes | — | ID do pedido |
fields | string | No | — | Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ”,“ |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"order_id": {
"type": "integer",
"description": "ID do pedido"
},
"fields": {
"type": "string",
"description": "Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por \",\""
}
},
"required": [
"PCID",
"event_id",
"order_id"
]
}
sympla_get_orders
Listar pedidos por evento Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
status | string | No | — | Retorna todos os pedidos com qualquer status. true Retorna os pedidos de todos os status; false Retorna apenas os pedidos com status “A”. |
page_size | integer | No | — | Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200. |
page | integer | No | — | Especifica qual página o usuário deseja visualizar. Mínimo 1. |
field_sort | string | No | — | Permite que os resultados sejam ordenados. |
sort | string | No | — | Permite que os resultados sejam ordenados. |
fields | string | No | — | Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ”,“ |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"status": {
"type": "string",
"description": "Retorna todos os pedidos com qualquer status. true Retorna os pedidos de todos os status; false Retorna apenas os pedidos com status \"A\".",
"enum": [
"true",
"false"
]
},
"page_size": {
"type": "integer",
"description": "Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200."
},
"page": {
"type": "integer",
"description": "Especifica qual página o usuário deseja visualizar. Mínimo 1."
},
"field_sort": {
"type": "string",
"description": "Permite que os resultados sejam ordenados."
},
"sort": {
"type": "string",
"description": "Permite que os resultados sejam ordenados.",
"enum": [
"ASC",
"DESC"
]
},
"fields": {
"type": "string",
"description": "Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por \",\""
}
},
"required": [
"PCID",
"event_id"
]
}
sympla_get_participant
Listar participante por id do ingresso Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
participant_id | integer | Yes | — | ID do participante |
cancelled_filter | string | No | — | Permite retornar participantes com status do pedido cancelado. |
fields | string | No | — | Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ”,“ |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"participant_id": {
"type": "integer",
"description": "ID do participante"
},
"cancelled_filter": {
"type": "string",
"description": "Permite retornar participantes com status do pedido cancelado.",
"enum": [
"none",
"include",
"only"
]
},
"fields": {
"type": "string",
"description": "Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por \",\""
}
},
"required": [
"PCID",
"event_id",
"participant_id"
]
}
sympla_get_participant_per_ticket_number
Listar participante por número de ingresso Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
ticket_number | string | Yes | — | Número do ingresso |
cancelled_filter | string | No | — | Permite retornar participantes com status do pedido cancelado. |
fields | string | No | — | Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ”,“ |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"ticket_number": {
"type": "string",
"description": "Número do ingresso"
},
"cancelled_filter": {
"type": "string",
"description": "Permite retornar participantes com status do pedido cancelado.",
"enum": [
"none",
"include",
"only"
]
},
"fields": {
"type": "string",
"description": "Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por \",\""
}
},
"required": [
"PCID",
"event_id",
"ticket_number"
]
}
sympla_get_participants
Listar participantes por pedido Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
order_id | integer | Yes | — | ID do pedido |
cancelled | string | No | — | Especifica se deve incluir pedidos cancelados na busca. |
page_size | integer | No | — | Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200. |
page | integer | No | — | Especifica qual página o usuário deseja visualizar. Mínimo 1. |
field_sort | string | No | — | Permite que os resultados sejam ordenados. |
sort | string | No | — | Permite que os resultados sejam ordenados. |
fields | string | No | — | Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ”,“ |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"order_id": {
"type": "integer",
"description": "ID do pedido"
},
"cancelled": {
"type": "string",
"description": "Especifica se deve incluir pedidos cancelados na busca.",
"enum": [
"true",
"false"
]
},
"page_size": {
"type": "integer",
"description": "Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200."
},
"page": {
"type": "integer",
"description": "Especifica qual página o usuário deseja visualizar. Mínimo 1."
},
"field_sort": {
"type": "string",
"description": "Permite que os resultados sejam ordenados."
},
"sort": {
"type": "string",
"description": "Permite que os resultados sejam ordenados.",
"enum": [
"ASC",
"DESC"
]
},
"fields": {
"type": "string",
"description": "Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por \",\""
}
},
"required": [
"PCID",
"event_id",
"order_id"
]
}
sympla_get_participants_per_event
Listar participantes por evento Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
page_size | integer | No | — | Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200. |
page | integer | No | — | Especifica qual página o usuário deseja visualizar. Mínimo 1. |
field_sort | string | No | — | Permite que os resultados sejam ordenados. |
sort | string | No | — | Permite que os resultados sejam ordenados. |
fields | string | No | — | Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por ”,“ |
cancelled_filter | string | No | — | Permite retornar participantes com status do pedido cancelado. |
ticket_number | string | No | — | 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 | No | — | 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"page_size": {
"type": "integer",
"description": "Especifica quantos registros por página o usuário deseja. Mínimo 1 e maxímo 200."
},
"page": {
"type": "integer",
"description": "Especifica qual página o usuário deseja visualizar. Mínimo 1."
},
"field_sort": {
"type": "string",
"description": "Permite que os resultados sejam ordenados."
},
"sort": {
"type": "string",
"description": "Permite que os resultados sejam ordenados.",
"enum": [
"ASC",
"DESC"
]
},
"fields": {
"type": "string",
"description": "Deve ser utilizado para retornar apenas os atributos indicados do objeto. Os atributos indicados devem ser separados por \",\""
},
"cancelled_filter": {
"type": "string",
"description": "Permite retornar participantes com status do pedido cancelado.",
"enum": [
"none",
"include",
"only"
]
},
"ticket_number": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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."
}
},
"required": [
"PCID",
"event_id"
]
}
sympla_post_check_in_participant_id
Check-in por id do ingresso. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
participant_id | integer | Yes | — | ID do participante |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"participant_id": {
"type": "integer",
"description": "ID do participante"
}
},
"required": [
"PCID",
"event_id",
"participant_id"
]
}
sympla_post_check_in_ticket_number
Check-in por número do ingresso. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_id | integer | Yes | — | ID do evento |
ticket_number | string | Yes | — | Número do ingresso |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_id": {
"type": "integer",
"description": "ID do evento"
},
"ticket_number": {
"type": "string",
"description": "Número do ingresso"
}
},
"required": [
"PCID",
"event_id",
"ticket_number"
]
}