> For the complete documentation index, see [llms.txt](https://docs.entrytickets.eu/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.entrytickets.eu/dashboard/tickets/list.md).

# List

## Retrieving tickets

The tickets list API allows you to retrieve a detailed list of individual tickets, including scan status, customer details, and custom metadata fields.

**Note**: Refunded tickets are automatically excluded from the results. The metadata fields returned depend on the ticket types configured for the event and will vary based on the custom options available.

### Request

<mark style="color:green;">`GET`</mark> `/tickets/list`

**Params**

<table><thead><tr><th width="125.46484375">Parameter</th><th width="128.83203125">Required</th><th width="101.578125">Type</th><th>Description</th></tr></thead><tbody><tr><td>event</td><td><strong>Required</strong></td><td>string</td><td>Event slug identifier</td></tr><tr><td>from</td><td>Optional</td><td>string</td><td>Start date and time (format: <code>YYYY-MM-DD HH:MM:SS</code>)</td></tr><tr><td>to</td><td>Optional</td><td>string</td><td>End date and time (format: <code>YYYY-MM-DD HH:MM:SS</code>)</td></tr><tr><td>page</td><td>Optional</td><td>int</td><td>The current page of the results (default: 1)</td></tr><tr><td>limit</td><td>Optional</td><td>int</td><td>Number of results per page (default: 100, max: 10,000)</td></tr></tbody></table>

**Request Example**

```
curl --request GET \
  --url 'https://entrytickets.be/api/tickets/list?event=summer-festival&from=2024-08-31%2020%3A00%3A00&to=2025-09-30%2020%3A00%3A00&page=1&limit=100'
```

**Response**

{% tabs %}
{% tab title="200" %}

```json
{
  "tickets": [
    {
      "date": "2024-08-15 14:32:18",
      "code": "ABC123DEF456",
      "transaction_id": "a8f94b2c-7e15-4d89-bf23-9c4e8a7f6d12",
      "type": "weekend_pass_early",
      "name": "Sarah Johnson",
      "email": "sarah.johnson@example.com",
      "note": "",
      "scan_date": "2024-08-16 18:45:22",
      "metadata": {
        "tier": "vip",
        "meal_preference": "vegetarian",
        "age_group": "adult"
      }
    },
    {
      "date": "2024-08-15 14:32:18",
      "code": "GHI789JKL012",
      "transaction_id": "a8f94b2c-7e15-4d89-bf23-9c4e8a7f6d12",
      "type": "Weekend Pass (Early Bird)",
      "name": "Michael Chen",
      "email": "sarah.johnson@example.com",
      "note": "",
      "scan_date": null,
      "metadata": {
        "tier": "standard",
        "meal_preference": "none",
        "age_group": "adult"
      }
    }
  ],
  "meta_fields": [
    {
      "key": "tier",
      "label": "Ticket Tier"
    },
    {
      "key": "meal_preference",
      "label": "Meal Preference"
    },
    {
      "key": "age_group",
      "label": "Age Group"
    }
  ],
  "total": 2847,
  "page": 1,
  "pages": 29,
  "limit": 100
}
```

{% endtab %}

{% tab title="400" %}

```json
{
  "error": "Invalid request"
}
```

{% endtab %}
{% endtabs %}

**General Response Fields**

<table><thead><tr><th width="149.07421875">Field</th><th width="115.78125">Type</th><th>Description</th></tr></thead><tbody><tr><td>tickets</td><td>array</td><td>List of individual ticket objects</td></tr><tr><td>meta_fields</td><td>array</td><td>Available metadata fields with labels</td></tr><tr><td>total</td><td>int</td><td>Total number of tickets available</td></tr><tr><td>page</td><td>int</td><td>Current page number</td></tr><tr><td>pages</td><td>int</td><td>Total number of pages</td></tr><tr><td>limit</td><td>int</td><td>Number of tickets per page</td></tr></tbody></table>

**Ticket Response Fields**

<table><thead><tr><th width="196.5078125">Field</th><th>Description</th></tr></thead><tbody><tr><td>date</td><td>The timestamp when the ticket was created (<code>YYYY-MM-DD HH:MM:SS</code>)</td></tr><tr><td>code</td><td>The unique ticket code/barcode</td></tr><tr><td>transaction_id</td><td>The transaction ID this ticket belongs to</td></tr><tr><td>type</td><td>The ticket type name</td></tr><tr><td>name</td><td>Name assigned to the ticket holder</td></tr><tr><td>email</td><td>Customer's email address</td></tr><tr><td>note</td><td>Additional note</td></tr><tr><td>scan_date</td><td>The timestamp when the ticket was scanned (null if not scanned)</td></tr><tr><td>metadata</td><td>Object containing custom ticket metadata based on ticket type options</td></tr></tbody></table>

**Metadata fields response**

<table><thead><tr><th width="113.03125">Field</th><th>Description</th></tr></thead><tbody><tr><td>key</td><td>The metadata field identifier</td></tr><tr><td>label</td><td>The human-readable label for the field</td></tr></tbody></table>