> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Sympla API reference

> API reference for the Sympla plugin in Corsair: every `sympla.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Events

### get

`events.get`

Get one event: dates, address, host, category and publication status.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.events.get({ event_id: 'abc123def456' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   data: {
>     id: string | number,
>     reference_id?: number | null,
>     name?: string | null,
>     detail?: string | null,
>     start_date?: string | null,
>     end_date?: string | null,
>     private_event?: boolean | number | null,
>     published?: boolean | number | null,
>     cancelled?: boolean | number | null,
>     image?: string | null,
>     url?: string | null,
>     address?: Record<string, any> | null,
>     host?: Record<string, any> | null,
>     category_prim?: Record<string, any> | null,
>     category_sec?: Record<string, any> | null
>   }
> } | {
>   id: string | number,
>   reference_id?: number | null,
>   name?: string | null,
>   detail?: string | null,
>   start_date?: string | null,
>   end_date?: string | null,
>   private_event?: boolean | number | null,
>   published?: boolean | number | null,
>   cancelled?: boolean | number | null,
>   image?: string | null,
>   url?: string | null,
>   address?: Record<string, any> | null,
>   host?: Record<string, any> | null,
>   category_prim?: Record<string, any> | null,
>   category_sec?: Record<string, any> | null
> }
> ```

***

### list

`events.list`

List the events of the Sympla organizer, with cursor pagination.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.events.list({ published: 'all', page_size: 50 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `published` | `published \| not_published \| all` | No | Publication filter. Sympla default: published. |
| `from` | `string` | No | Start of the date range, local ISO-8601, e.g. 2025-09-08T00:00:00. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `sort` | `asc \| desc` | No | Sort direction. |
| `field_sort` | `start_date \| end_date \| name` | No | Sort field. Sympla default: start\_date. |
| `page_size` | `number` | No | Items per page, 1 to 200. Sympla default 100. |
| `cursor` | `string` | No | pagination.next\_cursor from the previous page. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |

`published` is published (Sympla default), not\_published or all. Pass `pagination.next_cursor` as `cursor` for the next page.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |
| `pagination` | `object` | No | — |
| `sort` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   reference_id?: number | null,
>   name?: string | null,
>   detail?: string | null,
>   start_date?: string | null,
>   end_date?: string | null,
>   private_event?: boolean | number | null,
>   published?: boolean | number | null,
>   cancelled?: boolean | number | null,
>   image?: string | null,
>   url?: string | null,
>   address?: Record<string, any> | null,
>   host?: Record<string, any> | null,
>   category_prim?: Record<string, any> | null,
>   category_sec?: Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   next_cursor?: string | null,
>   page_size?: number | null,
>   quantity?: number | null
> }
> ```

> [accordion] sort full type
>
> ```ts theme={null}
> {
>   field_sort?: string | null,
>   sort?: string | null
> }
> ```

***

## Orders

### get

`orders.get`

Get one order of an event.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.orders.get({ event_id: 'abc123def456', order_id: 'ORD123' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `order_id` | `string` | Yes | Order id from orders.list. |

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   data: {
>     id: string | number,
>     event_id?: string | number | null,
>     presentation_id?: string | number | null,
>     order_date?: string | null,
>     order_status?: string | null,
>     updated_date?: string | null,
>     approved_date?: string | null,
>     discount_code?: string | null,
>     transaction_type?: string | null,
>     order_total_sale_price?: number | null,
>     order_total_net_value?: number | null,
>     buyer_first_name?: string | null,
>     buyer_last_name?: string | null,
>     buyer_email?: string | null,
>     invoice_info?: Record<string, any> | null,
>     utm?: Record<string, any> | null
>   }
> } | {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_id?: string | number | null,
>   order_date?: string | null,
>   order_status?: string | null,
>   updated_date?: string | null,
>   approved_date?: string | null,
>   discount_code?: string | null,
>   transaction_type?: string | null,
>   order_total_sale_price?: number | null,
>   order_total_net_value?: number | null,
>   buyer_first_name?: string | null,
>   buyer_last_name?: string | null,
>   buyer_email?: string | null,
>   invoice_info?: Record<string, any> | null,
>   utm?: Record<string, any> | null
> }
> ```

***

### list

`orders.list`

List the orders of an event, filterable by date, buyer email and cancelled status.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.orders.list({ event_id: 'abc123def456', from: '2025-09-08T00:00:00', to: '2025-09-09T23:59:59' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `from` | `string` | No | Start of the date range, local ISO-8601, e.g. 2025-09-08T00:00:00. |
| `to` | `string` | No | End of the date range, local ISO-8601, e.g. 2025-09-09T23:59:59. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |
| `cancelled_filter` | `none \| include \| only` | No | Cancelled records: none (default), include or only. |
| `buyer_email` | `string` | No | Only orders by this buyer email (exact match). |
| `page_size` | `number` | No | Items per page, 1 to 200. Sympla default 100. |
| `cursor` | `string` | No | pagination.next\_cursor from the previous page. |
| `field_sort` | `order_date \| updated_date \| approved_date \| buyer_email \| status \| id` | No | Sort field. Sympla default: order\_date. |
| `sort` | `asc \| desc` | No | Sort direction. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |
| `pagination` | `object` | No | — |
| `sort` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_id?: string | number | null,
>   order_date?: string | null,
>   order_status?: string | null,
>   updated_date?: string | null,
>   approved_date?: string | null,
>   discount_code?: string | null,
>   transaction_type?: string | null,
>   order_total_sale_price?: number | null,
>   order_total_net_value?: number | null,
>   buyer_first_name?: string | null,
>   buyer_last_name?: string | null,
>   buyer_email?: string | null,
>   invoice_info?: Record<string, any> | null,
>   utm?: Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   next_cursor?: string | null,
>   page_size?: number | null,
>   quantity?: number | null
> }
> ```

> [accordion] sort full type
>
> ```ts theme={null}
> {
>   field_sort?: string | null,
>   sort?: string | null
> }
> ```

***

### listByPresentation

`orders.listByPresentation`

List the orders of one presentation of an event.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.orders.listByPresentation({ event_id: 'abc123def456', presentation_id: 12345 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `presentation_id` | `number \| string` | Yes | Presentation (session) id from presentations.list. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `from` | `string` | No | Start of the date range, local ISO-8601, e.g. 2025-09-08T00:00:00. |
| `to` | `string` | No | End of the date range, local ISO-8601, e.g. 2025-09-09T23:59:59. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |
| `cancelled_filter` | `none \| include \| only` | No | Cancelled records: none (default), include or only. |
| `buyer_email` | `string` | No | Only orders by this buyer email (exact match). |
| `page_size` | `number` | No | Items per page, 1 to 200. Sympla default 100. |
| `cursor` | `string` | No | pagination.next\_cursor from the previous page. |
| `field_sort` | `order_date \| updated_date \| approved_date \| buyer_email \| status \| id` | No | Sort field. Sympla default: order\_date. |
| `sort` | `asc \| desc` | No | Sort direction. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |
| `pagination` | `object` | No | — |
| `sort` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_id?: string | number | null,
>   order_date?: string | null,
>   order_status?: string | null,
>   updated_date?: string | null,
>   approved_date?: string | null,
>   discount_code?: string | null,
>   transaction_type?: string | null,
>   order_total_sale_price?: number | null,
>   order_total_net_value?: number | null,
>   buyer_first_name?: string | null,
>   buyer_last_name?: string | null,
>   buyer_email?: string | null,
>   invoice_info?: Record<string, any> | null,
>   utm?: Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   next_cursor?: string | null,
>   page_size?: number | null,
>   quantity?: number | null
> }
> ```

> [accordion] sort full type
>
> ```ts theme={null}
> {
>   field_sort?: string | null,
>   sort?: string | null
> }
> ```

***

## Participants

### checkIn

`participants.checkIn`

Check a participant in by participant id. The API has no way to undo a check-in.

**Risk:** `destructive`

```ts theme={null}
await corsair.sympla.api.participants.checkIn({ event_id: 'abc123def456', participant_id: 12345 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `participant_id` | `number \| string` | Yes | Participant id from participants.list. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   check_in?: boolean | null,
>   check_in_date?: string | null,
>   check_in_id?: string | number | null
> }
> ```

***

### checkInByQrCode

`participants.checkInByQrCode`

Check a participant in with the fields of a scanned ticket QR code. The API has no way to undo a check-in.

**Risk:** `destructive`

```ts theme={null}
await corsair.sympla.api.participants.checkInByQrCode({
	event_id: 'abc123def456',
	itemId: 'item-1',
	walletId: 'wallet-1',
	signature: '<130-132 character signature from the QR code>',
	timestamp: 1698770407738,
	version: 1,
});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `itemId` | `string` | Yes | itemId from the scanned QR code payload. |
| `walletId` | `string` | Yes | walletId from the scanned QR code payload. |
| `signature` | `string` | Yes | signature from the scanned QR code payload. |
| `timestamp` | `number` | Yes | timestamp from the scanned QR code payload. |
| `version` | `number` | Yes | version from the scanned QR code payload. |

Pass the fields of the decoded ticket QR code (`itemId`, `walletId`, `signature`, `timestamp`, `version`). An expired code answers HTTP 410.

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   check_in?: boolean | null,
>   check_in_date?: string | null,
>   check_in_id?: string | number | null
> }
> ```

***

### checkInByTicketNumber

`participants.checkInByTicketNumber`

Check a participant in by ticket number. The API has no way to undo a check-in.

**Risk:** `destructive`

```ts theme={null}
await corsair.sympla.api.participants.checkInByTicketNumber({ event_id: 'abc123def456', ticket_number: '94461180000001' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `ticket_number` | `string` | Yes | Ticket number printed on the ticket, e.g. 94461180000001. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object` | Yes | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   check_in?: boolean | null,
>   check_in_date?: string | null,
>   check_in_id?: string | number | null
> }
> ```

***

### get

`participants.get`

Get one participant of an event by participant id.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.participants.get({ event_id: 'abc123def456', participant_id: 12345 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `participant_id` | `number \| string` | Yes | Participant id from participants.list. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   data: {
>     id: string | number,
>     event_id?: string | number | null,
>     presentation_id?: string | number | null,
>     order_id?: string | number | null,
>     order_status?: string | null,
>     first_name?: string | null,
>     last_name?: string | null,
>     email?: string | null,
>     ticket_number?: string | null,
>     ticket_num_qr_code?: string | null,
>     ticket_name?: string | null,
>     ticket_status?: string | null,
>     ticket_sale_price?: number | null,
>     ticket_net_value?: number | null,
>     sector_name?: string | null,
>     checkin?: Record<string, any> | null,
>     custom_form?: any[] | Record<string, any> | null
>   }
> } | {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_id?: string | number | null,
>   order_id?: string | number | null,
>   order_status?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   email?: string | null,
>   ticket_number?: string | null,
>   ticket_num_qr_code?: string | null,
>   ticket_name?: string | null,
>   ticket_status?: string | null,
>   ticket_sale_price?: number | null,
>   ticket_net_value?: number | null,
>   sector_name?: string | null,
>   checkin?: Record<string, any> | null,
>   custom_form?: any[] | Record<string, any> | null
> }
> ```

***

### getByTicketNumber

`participants.getByTicketNumber`

Get one participant of an event by ticket number.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.participants.getByTicketNumber({ event_id: 'abc123def456', ticket_number: '94461180000001' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `ticket_number` | `string` | Yes | Ticket number printed on the ticket, e.g. 94461180000001. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   data: {
>     id: string | number,
>     event_id?: string | number | null,
>     presentation_id?: string | number | null,
>     order_id?: string | number | null,
>     order_status?: string | null,
>     first_name?: string | null,
>     last_name?: string | null,
>     email?: string | null,
>     ticket_number?: string | null,
>     ticket_num_qr_code?: string | null,
>     ticket_name?: string | null,
>     ticket_status?: string | null,
>     ticket_sale_price?: number | null,
>     ticket_net_value?: number | null,
>     sector_name?: string | null,
>     checkin?: Record<string, any> | null,
>     custom_form?: any[] | Record<string, any> | null
>   }
> } | {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_id?: string | number | null,
>   order_id?: string | number | null,
>   order_status?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   email?: string | null,
>   ticket_number?: string | null,
>   ticket_num_qr_code?: string | null,
>   ticket_name?: string | null,
>   ticket_status?: string | null,
>   ticket_sale_price?: number | null,
>   ticket_net_value?: number | null,
>   sector_name?: string | null,
>   checkin?: Record<string, any> | null,
>   custom_form?: any[] | Record<string, any> | null
> }
> ```

***

### list

`participants.list`

List the participants (tickets) of an event, with check-in status.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.participants.list({ event_id: 'abc123def456', page_size: 100 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `from` | `string` | No | Start of the ticket\_updated\_at range, local ISO-8601. |
| `to` | `string` | No | End of the ticket\_updated\_at range, local ISO-8601. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |
| `cancelled_filter` | `none \| include \| only` | No | Cancelled records: none (default), include or only. |
| `participant_email` | `string` | No | Only participants with this email (exact match). |
| `page_size` | `number` | No | Items per page, 1 to 500. Sympla default 100. |
| `cursor` | `string` | No | pagination.next\_cursor from the previous page. |
| `field_sort` | `ticket_created_at \| ticket_updated_at` | No | Sort field. Sympla default: ticket\_created\_at. |
| `sort` | `asc \| desc` | No | Sort direction. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |
| `pagination` | `object` | No | — |
| `sort` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_id?: string | number | null,
>   order_id?: string | number | null,
>   order_status?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   email?: string | null,
>   ticket_number?: string | null,
>   ticket_num_qr_code?: string | null,
>   ticket_name?: string | null,
>   ticket_status?: string | null,
>   ticket_sale_price?: number | null,
>   ticket_net_value?: number | null,
>   sector_name?: string | null,
>   checkin?: Record<string, any> | null,
>   custom_form?: any[] | Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   next_cursor?: string | null,
>   page_size?: number | null,
>   quantity?: number | null
> }
> ```

> [accordion] sort full type
>
> ```ts theme={null}
> {
>   field_sort?: string | null,
>   sort?: string | null
> }
> ```

***

### listByOrder

`participants.listByOrder`

List the participants (tickets) in one order.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.participants.listByOrder({ event_id: 'abc123def456', order_id: 'ORD123' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `order_id` | `string` | Yes | Order id from orders.list. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `cancelled_filter` | `none \| include \| only` | No | Cancelled records: none (default), include or only. |
| `page_size` | `number` | No | Items per page, 1 to 500. Sympla default 100. |
| `cursor` | `string` | No | pagination.next\_cursor from the previous page. |
| `field_sort` | `ticket_created_at \| ticket_updated_at` | No | Sort field. Sympla default: ticket\_created\_at. |
| `sort` | `asc \| desc` | No | Sort direction. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |
| `pagination` | `object` | No | — |
| `sort` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_id?: string | number | null,
>   order_id?: string | number | null,
>   order_status?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   email?: string | null,
>   ticket_number?: string | null,
>   ticket_num_qr_code?: string | null,
>   ticket_name?: string | null,
>   ticket_status?: string | null,
>   ticket_sale_price?: number | null,
>   ticket_net_value?: number | null,
>   sector_name?: string | null,
>   checkin?: Record<string, any> | null,
>   custom_form?: any[] | Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   next_cursor?: string | null,
>   page_size?: number | null,
>   quantity?: number | null
> }
> ```

> [accordion] sort full type
>
> ```ts theme={null}
> {
>   field_sort?: string | null,
>   sort?: string | null
> }
> ```

***

### listByPresentation

`participants.listByPresentation`

List the participants (tickets) of one presentation.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.participants.listByPresentation({ event_id: 'abc123def456', presentation_id: 12345 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `presentation_id` | `number \| string` | Yes | Presentation (session) id from presentations.list. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `from` | `string` | No | Start of the ticket\_updated\_at range, local ISO-8601. |
| `to` | `string` | No | End of the ticket\_updated\_at range, local ISO-8601. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |
| `cancelled_filter` | `none \| include \| only` | No | Cancelled records: none (default), include or only. |
| `participant_email` | `string` | No | Only participants with this email (exact match). |
| `page_size` | `number` | No | Items per page, 1 to 500. Sympla default 100. |
| `cursor` | `string` | No | pagination.next\_cursor from the previous page. |
| `field_sort` | `ticket_created_at \| ticket_updated_at` | No | Sort field. Sympla default: ticket\_created\_at. |
| `sort` | `asc \| desc` | No | Sort direction. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |
| `pagination` | `object` | No | — |
| `sort` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_id?: string | number | null,
>   order_id?: string | number | null,
>   order_status?: string | null,
>   first_name?: string | null,
>   last_name?: string | null,
>   email?: string | null,
>   ticket_number?: string | null,
>   ticket_num_qr_code?: string | null,
>   ticket_name?: string | null,
>   ticket_status?: string | null,
>   ticket_sale_price?: number | null,
>   ticket_net_value?: number | null,
>   sector_name?: string | null,
>   checkin?: Record<string, any> | null,
>   custom_form?: any[] | Record<string, any> | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   next_cursor?: string | null,
>   page_size?: number | null,
>   quantity?: number | null
> }
> ```

> [accordion] sort full type
>
> ```ts theme={null}
> {
>   field_sort?: string | null,
>   sort?: string | null
> }
> ```

***

## Presentations

### get

`presentations.get`

Get one presentation of an event, with its sectors.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.presentations.get({ event_id: 'abc123def456', presentation_id: 12345 });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `presentation_id` | `number \| string` | Yes | Presentation (session) id from presentations.list. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   data: {
>     id: string | number,
>     event_id?: string | number | null,
>     presentation_url?: string | null,
>     closed?: boolean | number | null,
>     enabled?: boolean | number | null,
>     private_presentation?: boolean | number | null,
>     published?: boolean | number | null,
>     start_date?: string | null,
>     end_date?: string | null,
>     start_date_utc?: string | null,
>     end_date_utc?: string | null,
>     sectors?: {
>       id?: string | number | null,
>       name?: string | null,
>       has_online_sale_available?: boolean | number | null
>     }[] | null
>   }
> } | {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_url?: string | null,
>   closed?: boolean | number | null,
>   enabled?: boolean | number | null,
>   private_presentation?: boolean | number | null,
>   published?: boolean | number | null,
>   start_date?: string | null,
>   end_date?: string | null,
>   start_date_utc?: string | null,
>   end_date_utc?: string | null,
>   sectors?: {
>     id?: string | number | null,
>     name?: string | null,
>     has_online_sale_available?: boolean | number | null
>   }[] | null
> }
> ```

***

### list

`presentations.list`

List the presentations (sessions or dates) of an event.

**Risk:** `read`

```ts theme={null}
await corsair.sympla.api.presentations.list({ event_id: 'abc123def456' });
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `event_id` | `string` | Yes | Event id hash, the `id` from events.list. |
| `published` | `boolean` | No | Only published presentations. Sympla default: true. |
| `from` | `string` | No | Start of the date range, local ISO-8601, e.g. 2025-09-08T00:00:00. |
| `timezone` | `string` | No | IANA timezone for dates in and out. Sympla default: America/Sao\_Paulo. |
| `sort` | `asc \| desc` | No | Sort direction. |
| `field_sort` | `start_date` | No | Sort field: start\_date. |
| `filter_online_sector` | `boolean` | No | Only sectors sold online. Sympla default: true. |
| `page_size` | `number` | No | Items per page, 1 to 200. Sympla default 100. |
| `cursor` | `string` | No | pagination.next\_cursor from the previous page. |
| `fields` | `string` | No | Comma-separated snake\_case fields to return. Omit for all. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `object[]` | Yes | — |
| `pagination` | `object` | No | — |
| `sort` | `object` | No | — |

> [accordion] data full type
>
> ```ts theme={null}
> {
>   id: string | number,
>   event_id?: string | number | null,
>   presentation_url?: string | null,
>   closed?: boolean | number | null,
>   enabled?: boolean | number | null,
>   private_presentation?: boolean | number | null,
>   published?: boolean | number | null,
>   start_date?: string | null,
>   end_date?: string | null,
>   start_date_utc?: string | null,
>   end_date_utc?: string | null,
>   sectors?: {
>     id?: string | number | null,
>     name?: string | null,
>     has_online_sale_available?: boolean | number | null
>   }[] | null
> }[]
> ```

> [accordion] pagination full type
>
> ```ts theme={null}
> {
>   next_cursor?: string | null,
>   page_size?: number | null,
>   quantity?: number | null
> }
> ```

> [accordion] sort full type
>
> ```ts theme={null}
> {
>   field_sort?: string | null,
>   sort?: string | null
> }
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.