---
title: "Lists the guests the customer bought an event's tickets for, and whether each opened theirs."
---

> 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 customer API › event

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

## Authentication

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

## Path parameters

- `store` (`listEventGuests.path.store`; string, required) — A hostname of the store.
- `product` (`listEventGuests.path.product`; string, required) — An id, or `slug:<slug>`.
  - minLength 1

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://api.sherpo.io/customer/v1/stores/<store>/products/<product>/guests';
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/customer/v1/stores/<store>/products/<product>/guests"

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

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

print(response.text)
```

## Responses

### 200

Lists the guests the customer bought an event's tickets for, and whether each opened theirs.

#### Example

```json
{
  "guests": [
    {
      "id": "string",
      "product_id": "string",
      "order_id": "string",
      "order_item_id": "string",
      "name": "string",
      "email": "string",
      "status": "string",
      "opened_at": "string",
      "created_at": "string",
      "ended_at": "string",
      "changeable": true,
      "resendable": true
    }
  ],
  "attending": true,
  "lines": [
    {
      "order_item_id": "string",
      "buyer_ticket": true
    }
  ]
}
```

- `guests` (`listEventGuests.response.200.guests`; array<object>, required)
  - `id` (`listEventGuests.response.200.guests.id`; string, required)
  - `product_id` (`listEventGuests.response.200.guests.product_id`; string, required)
  - `order_id` (`listEventGuests.response.200.guests.order_id`; string, required)
  - `order_item_id` (`listEventGuests.response.200.guests.order_item_id`; string, required)
  - `name` (`listEventGuests.response.200.guests.name`; any of, required)
    - any of: `string`, `null`
  - `email` (`listEventGuests.response.200.guests.email`; any of, required)
    - any of: `string`, `null`
  - `status` (`listEventGuests.response.200.guests.status`; string, required) — `active` while theirs, `refunded` once a refund ended it.
  - `opened_at` (`listEventGuests.response.200.guests.opened_at`; any of, required) — When they signed in holding it, else first were let in at the door; null while neither.
    - any of: `string`, `null`
  - `created_at` (`listEventGuests.response.200.guests.created_at`; any of, required)
    - any of: `string`, `null`
  - `ended_at` (`listEventGuests.response.200.guests.ended_at`; any of, required)
    - any of: `string`, `null`
  - `changeable` (`listEventGuests.response.200.guests.changeable`; boolean, required) — Whether the buyer may still hand it to someone else: before its guest opened it, before the event starts, and while it stands.
  - `resendable` (`listEventGuests.response.200.guests.resendable`; boolean, required) — Whether the buyer may send its mail again; never once the event is canceled.
- `attending` (`listEventGuests.response.200.attending`; boolean, required) — Whether the caller is on the event's guest list themselves.
- `lines` (`listEventGuests.response.200.lines`; array<object>, required) — Each line of the caller's orders of the event, oldest first.
  - `order_item_id` (`listEventGuests.response.200.lines.order_item_id`; string, required)
  - `buyer_ticket` (`listEventGuests.response.200.lines.buyer_ticket`; boolean, required) — Whether the line kept one of its tickets for the buyer; one naming a guest for every ticket keeps none.

### default

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

#### Example

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

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


Source: https://docs.sherpo.io/customer-api/reference/list-event-guests/index.md
