Skip to content

List event guests

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

Needs the read scope.

Call

  • Tool: list_event_guests
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
guests array of object Yes
attending boolean Yes Whether the caller is on the event’s guest list themselves.
lines array of object Yes Each line of the caller’s orders of the event, oldest first.

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close