---
title: "Pages an event's guest list: one row per person, going or canceled, with their tier and how they got their ticket."
---

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

Path: Sherpo merchant API › customer

`GET /v1/stores/{store}/products/{product}/attendees`

## Authentication

- `bearer`, http, header `Authorization`, scopes: `customer:read`

## Path parameters

- `store` (`listEventAttendees.path.store`; string, required) — The store's id.
- `product` (`listEventAttendees.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Query parameters

- `filter` (`listEventAttendees.query.filter`; object, optional) — `filter[<field>]=<value>` is an equality, `filter[<field>][<op>]=<value>` names the operator; `in` repeats the parameter.
- `sort` (`listEventAttendees.query.sort`; string, optional) — Sorted by canceled, rows without a value come last either way.
  - one of `"registered"`, `"canceled"`
- `direction` (`listEventAttendees.query.direction`; string, optional)
  - one of `"asc"`, `"desc"`
- `limit` (`listEventAttendees.query.limit`; integer, optional)
  - min 1; max 100
- `cursor` (`listEventAttendees.query.cursor`; string, optional)
  - maxLength 8192
- `count` (`listEventAttendees.query.count`; boolean, optional)
- `search` (`listEventAttendees.query.search`; string, optional)
  - minLength 1; maxLength 200
- `facets` (`listEventAttendees.query.facets`; array<string>, optional)

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/attendees' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/attendees';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sherpo.io/merchant/v1/stores/<store>/products/<product>/attendees"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Pages an event's guest list: one row per person, going or canceled, with their tier and how they got their ticket.

#### Example

```json
{
  "items": [
    {
      "id": "string",
      "product_id": "string",
      "customer_id": "string",
      "status": "string",
      "cancel_reason": "string",
      "tier": {
        "id": "string",
        "name": "string",
        "rank": 0
      },
      "source": "string",
      "grant_id": "string",
      "order_id": "string",
      "registered_at": "string",
      "canceled_at": "string",
      "customer": {
        "id": "string",
        "name": "string",
        "email": "string",
        "phone": "string",
        "erased": true
      },
      "bought_by": {
        "customer_id": "string",
        "customer": {
          "id": "string",
          "name": "string",
          "email": "string",
          "phone": "string",
          "erased": true
        },
        "order_id": "string"
      },
      "guests": 0,
      "answers": [
        {
          "question_id": "string",
          "value": true
        }
      ],
      "answered_by": "string",
      "check_ins": [
        {
          "id": "string",
          "session_id": "string",
          "checked_in_at": "string"
        }
      ]
    }
  ],
  "cursor": "string",
  "total": 0,
  "facets": {
    "property1": {
      "property1": 0,
      "property2": 0
    },
    "property2": {
      "property1": 0,
      "property2": 0
    }
  }
}
```

- `items` (`listEventAttendees.response.200.items`; array<object>, required)
  - `id` (`listEventAttendees.response.200.items.id`; string, required)
  - `product_id` (`listEventAttendees.response.200.items.product_id`; string, required)
  - `customer_id` (`listEventAttendees.response.200.items.customer_id`; string, required)
  - `status` (`listEventAttendees.response.200.items.status`; string, required) — `going` while a grant holds, `pending` while their request waits for the seller's approval, `waitlisted` while they wait for a seat, `canceled` once none of these holds.
  - `cancel_reason` (`listEventAttendees.response.200.items.cancel_reason`; any of, required) — Why they no longer hold the event: `refunded`, `revoked`, `expired`, `declined`, or `canceled` when the seller canceled it; null unless canceled.
    - any of: `string`, `null`
  - `tier` (`listEventAttendees.response.200.items.tier`; any of, required) — The tier their access opens, else the one it last opened; null for access with no tier.
    - any of: `object`, `null`
  - `source` (`listEventAttendees.response.200.items.source`; string, required) — What gave the grant that admits them: `checkout`, `payment`, `subscription`, `automation`, `manual` or `api`; `waitlist` for a waitlist entry no grant admits yet.
  - `grant_id` (`listEventAttendees.response.200.items.grant_id`; any of, required) — The grant that admits them, else the one that ended last; null while a request waits.
    - any of: `string`, `null`
  - `order_id` (`listEventAttendees.response.200.items.order_id`; any of, required) — The order behind that grant's settlement; null for a grant no order paid.
    - any of: `string`, `null`
  - `registered_at` (`listEventAttendees.response.200.items.registered_at`; string, required) — When their current stretch of access began, or the one that ended for a canceled attendee.
  - `canceled_at` (`listEventAttendees.response.200.items.canceled_at`; any of, required)
    - any of: `string`, `null`
  - `customer` (`listEventAttendees.response.200.items.customer`; any of, required) — Who they are, `erased` once their details are wiped.
    - any of: `object`, `null`
  - `bought_by` (`listEventAttendees.response.200.items.bought_by`; any of, required) — For a guest someone else bought a ticket for: the buyer and the order; null otherwise.
    - any of: `object`, `null`
  - `guests` (`listEventAttendees.response.200.items.guests`; number, required) — How many guests they bought tickets for who still hold them.
  - `answers` (`listEventAttendees.response.200.items.answers`; array<object>, required) — Their answers to the product's registration questions, in the questions' order; a question left unanswered is absent.
    - `question_id` (`listEventAttendees.response.200.items.answers.question_id`; string, required)
    - `value` (`listEventAttendees.response.200.items.answers.value`; any of, required)
      - any of: `boolean`, `string`, `array<string>`
  - `answered_by` (`listEventAttendees.response.200.items.answered_by`; string, required) — Who gave `answers`: `buyer` for a guest with none of their own, showing their buyer's answers to the product; else `attendee`.
  - `check_ins` (`listEventAttendees.response.200.items.check_ins`; array<object>, required) — The sessions they were let in at, earliest first.
    - `id` (`listEventAttendees.response.200.items.check_ins.id`; string, required) — What an automation's run names as its trigger.
    - `session_id` (`listEventAttendees.response.200.items.check_ins.session_id`; string, required)
    - `checked_in_at` (`listEventAttendees.response.200.items.check_ins.checked_in_at`; string, required)
- `cursor` (`listEventAttendees.response.200.cursor`; any of, required)
  - any of: `string`, `null`
- `total` (`listEventAttendees.response.200.total`; number, optional)
- `facets` (`listEventAttendees.response.200.facets`; map<map<number>>, optional)

### default

A problem; see https://api.sherpo.io/merchant/docs/errors.

#### Example

```json
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "code": "string",
  "context": {},
  "reached_core": true,
  "core_answer": "string"
}
```

- `type` (`listEventAttendees.response.default.type`; string, required)
  - format `uri`
- `title` (`listEventAttendees.response.default.title`; string, required)
- `status` (`listEventAttendees.response.default.status`; integer, required)
- `detail` (`listEventAttendees.response.default.detail`; string, required)
- `code` (`listEventAttendees.response.default.code`; string, optional)
- `context` (`listEventAttendees.response.default.context`; object, optional)
- `reached_core` (`listEventAttendees.response.default.reached_core`; boolean, optional)
- `core_answer` (`listEventAttendees.response.default.core_answer`; string, optional)


Source: https://docs.sherpo.io/merchant-api/reference/list-event-attendees/index.md
