List all events

curl --request GET \
  --url https://{workspace}.attendu.com/api/v1/events \
  --header 'x-api-key: <api-key>'

{
  "results": [
    {
      "_id": "<string>",
      "general": {
        "title": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z",
        "timezone": "Europe/London",
        "location": {
          "placeName": "<string>",
          "address": "<string>",
          "city": "<string>",
          "zipCode": "<string>",
          "country": "<string>"
        },
        "langs": [
          "en",
          "cs"
        ],
        "ticketing": {
          "isEnabled": false,
          "currency": "czk",
          "taxRate": {
            "isEnabled": true,
            "type": "vat",
            "percentage": 21
          },
          "types": [
            {
              "id": "<string>",
              "_cs": {
                "name": "<string>",
                "description": "<string>"
              },
              "_en": {
                "name": "<string>",
                "description": "<string>"
              },
              "isFree": true,
              "priceExcludingTax": 0,
              "price": 0,
              "hasRestrictedVisibility": true,
              "visibleOnlyTo": [
                "<string>"
              ],
              "maxCapacity": 123
            }
          ],
          "hasPromoCodesEnabled": true,
          "promoCodes": [
            {
              "id": "<string>",
              "name": "<string>",
              "amount": 123,
              "code": "<string>",
              "maxUses": 123,
              "usage": [
                {
                  "buyerEmail": "<string>",
                  "usedAt": "2023-11-07T05:31:56Z",
                  "stripePaymentIntent": "<string>"
                }
              ]
            }
          ]
        }
      },
      "guestlist": {
        "properties": [
          {
            "id": "yN9hzaCj",
            "type": "select",
            "_cs": {
              "name": "Typ vstupenky"
            },
            "_en": {
              "name": "Ticket type"
            },
            "options": [
              {
                "id": "1QLXYBlw",
                "_cs": {
                  "value": "VIP"
                },
                "_en": {
                  "value": "VIP"
                }
              },
              {
                "id": "PCx9ruxP",
                "_cs": {
                  "value": "Standard"
                },
                "_en": {
                  "value": "Standard"
                }
              }
            ]
          },
          {
            "id": "X62TkjiV",
            "type": "text",
            "_cs": {
              "name": "Poznámka"
            },
            "_en": {
              "name": "Note"
            },
            "options": []
          },
          {
            "id": "Ybb48GO7",
            "type": "multiSelect",
            "_cs": {
              "name": "Zájmy"
            },
            "_en": {
              "name": "Interests"
            },
            "options": [
              {
                "id": "7bR7m2au",
                "_cs": {
                  "value": "Technologie"
                },
                "_en": {
                  "value": "Technology"
                }
              },
              {
                "id": "BdwYyYmi",
                "_cs": {
                  "value": "Byznys"
                },
                "_en": {
                  "value": "Business"
                }
              },
              {
                "id": "4igVHOnN",
                "_cs": {
                  "value": "Marketing"
                },
                "_en": {
                  "value": "Marketing"
                }
              }
            ]
          }
        ]
      },
      "pages": {
        "activePage": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

GET

events

List all events

curl --request GET \
  --url https://{workspace}.attendu.com/api/v1/events \
  --header 'x-api-key: <api-key>'

{
  "results": [
    {
      "_id": "<string>",
      "general": {
        "title": "<string>",
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z",
        "timezone": "Europe/London",
        "location": {
          "placeName": "<string>",
          "address": "<string>",
          "city": "<string>",
          "zipCode": "<string>",
          "country": "<string>"
        },
        "langs": [
          "en",
          "cs"
        ],
        "ticketing": {
          "isEnabled": false,
          "currency": "czk",
          "taxRate": {
            "isEnabled": true,
            "type": "vat",
            "percentage": 21
          },
          "types": [
            {
              "id": "<string>",
              "_cs": {
                "name": "<string>",
                "description": "<string>"
              },
              "_en": {
                "name": "<string>",
                "description": "<string>"
              },
              "isFree": true,
              "priceExcludingTax": 0,
              "price": 0,
              "hasRestrictedVisibility": true,
              "visibleOnlyTo": [
                "<string>"
              ],
              "maxCapacity": 123
            }
          ],
          "hasPromoCodesEnabled": true,
          "promoCodes": [
            {
              "id": "<string>",
              "name": "<string>",
              "amount": 123,
              "code": "<string>",
              "maxUses": 123,
              "usage": [
                {
                  "buyerEmail": "<string>",
                  "usedAt": "2023-11-07T05:31:56Z",
                  "stripePaymentIntent": "<string>"
                }
              ]
            }
          ]
        }
      },
      "guestlist": {
        "properties": [
          {
            "id": "yN9hzaCj",
            "type": "select",
            "_cs": {
              "name": "Typ vstupenky"
            },
            "_en": {
              "name": "Ticket type"
            },
            "options": [
              {
                "id": "1QLXYBlw",
                "_cs": {
                  "value": "VIP"
                },
                "_en": {
                  "value": "VIP"
                }
              },
              {
                "id": "PCx9ruxP",
                "_cs": {
                  "value": "Standard"
                },
                "_en": {
                  "value": "Standard"
                }
              }
            ]
          },
          {
            "id": "X62TkjiV",
            "type": "text",
            "_cs": {
              "name": "Poznámka"
            },
            "_en": {
              "name": "Note"
            },
            "options": []
          },
          {
            "id": "Ybb48GO7",
            "type": "multiSelect",
            "_cs": {
              "name": "Zájmy"
            },
            "_en": {
              "name": "Interests"
            },
            "options": [
              {
                "id": "7bR7m2au",
                "_cs": {
                  "value": "Technologie"
                },
                "_en": {
                  "value": "Technology"
                }
              },
              {
                "id": "BdwYyYmi",
                "_cs": {
                  "value": "Byznys"
                },
                "_en": {
                  "value": "Business"
                }
              },
              {
                "id": "4igVHOnN",
                "_cs": {
                  "value": "Marketing"
                },
                "_en": {
                  "value": "Marketing"
                }
              }
            ]
          }
        ]
      },
      "pages": {
        "activePage": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Authorizations

x-api-key

string

header

required

Query Parameters

filter

enum<string>

Filter events by time frame (upcoming/past).

Available options:

upcoming,

past

Response

Events retrieved successfully.

results

object[]

Show child attributes

results._id

string

Event ID

results.general

object

Show child attributes

results.general.title

string

Title of the event

results.general.startDate

string<date-time>

Start date of the event

results.general.endDate

string<date-time>

End date of the event

results.general.timezone

string

default:Europe/London

Timezone of the event

results.general.location

object

Show child attributes

results.general.location.placeName

string

Name of the event location

results.general.location.address

string

Address of the event location

results.general.location.city

string

City of the event location

results.general.location.zipCode

string

Zip code of the event location

results.general.location.country

string

Country of the event location

results.general.langs

string[]

Languages supported by the event

Example:

["en", "cs"]

results.general.ticketing

object

Ticketing configuration for the event

Show child attributes

results.general.ticketing.isEnabled

boolean

default:false

Whether ticketing is enabled for the event

results.general.ticketing.currency

enum<string>

Currency for the ticket price

Available options:

czk,

eur,

usd

Example:

"czk"

results.general.ticketing.taxRate

object

Tax rate configuration for ticketing

Show child attributes

results.general.ticketing.taxRate.isEnabled

boolean

Whether tax is enabled for ticketing

results.general.ticketing.taxRate.type

enum<string>

Type of tax applied to tickets

Available options:

vat,

salesTax,

gst

results.general.ticketing.taxRate.percentage

number

Tax percentage applied to tickets

Example:

21

results.general.ticketing.types

object[]

Array of ticket types for the event

Show child attributes

results.general.ticketing.types.id

string

Unique identifier for the ticket type

results.general.ticketing.types._cs

object

Show child attributes

results.general.ticketing.types._cs.name

string

Czech name of the ticket type

results.general.ticketing.types._cs.description

string

Czech description of the ticket type

results.general.ticketing.types._en

object

Show child attributes

results.general.ticketing.types._en.name

string

English name of the ticket type

results.general.ticketing.types._en.description

string

English description of the ticket type

results.general.ticketing.types.isFree

boolean

default:true

Whether the ticket type is free

results.general.ticketing.types.priceExcludingTax

number

default:0

Price of the ticket type excluding tax

results.general.ticketing.types.price

number

default:0

Price of the ticket type including tax

results.general.ticketing.types.hasRestrictedVisibility

boolean

Whether the ticket type has restricted visibility

results.general.ticketing.types.visibleOnlyTo

string[]

Array of group IDs or roles that can see this ticket type

results.general.ticketing.types.maxCapacity

number

Maximum capacity for this ticket type

Whether promo codes are enabled for the event ticketing.

Example:

true

Array of promo codes for ticket discounts.

Show child attributes

Unique identifier for the promo code (nanoid, 8 chars)

Name of the promo code (e.g. Internal discount)

Discount amount for the promo code.

Promo code (6 chars, uppercase, A-Z0-9)

Maximum number of times this promo code can be used.

Usage records for this promo code.

Show child attributes

Email of the buyer who used the promo code.

Date and time when the promo code was used.

Stripe payment intent ID associated with the usage.

results.guestlist

object

Show child attributes

results.guestlist.properties

object[]

Guestlist properties including any custom properties

Show child attributes

results.guestlist.properties.id

string

required

Unique identifier for the property

results.guestlist.properties.type

enum<string>

required

Type of the property field

Available options:

text,

select,

multiSelect

results.guestlist.properties._cs

object

Show child attributes

results.guestlist.properties._cs.name

string

Czech localization of property name

results.guestlist.properties._en

object

Show child attributes

results.guestlist.properties._en.name

string

English localization of property name

results.guestlist.properties.options

object[]

Show child attributes

results.guestlist.properties.options.id

string

required

Unique identifier for the option

results.guestlist.properties.options._cs

object

Show child attributes

results.guestlist.properties.options._cs.value

string

Czech localization of option value

results.guestlist.properties.options._en

object

Show child attributes

results.guestlist.properties.options._en.value

string

English localization of option value

Example:

{
  "properties": [
    {
      "id": "yN9hzaCj",
      "type": "select",
      "_cs": { "name": "Typ vstupenky" },
      "_en": { "name": "Ticket type" },
      "options": [
        {
          "id": "1QLXYBlw",
          "_cs": { "value": "VIP" },
          "_en": { "value": "VIP" }
        },
        {
          "id": "PCx9ruxP",
          "_cs": { "value": "Standard" },
          "_en": { "value": "Standard" }
        }
      ]
    },
    {
      "id": "X62TkjiV",
      "type": "text",
      "_cs": { "name": "Poznámka" },
      "_en": { "name": "Note" },
      "options": []
    },
    {
      "id": "Ybb48GO7",
      "type": "multiSelect",
      "_cs": { "name": "Zájmy" },
      "_en": { "name": "Interests" },
      "options": [
        {
          "id": "7bR7m2au",
          "_cs": { "value": "Technologie" },
          "_en": { "value": "Technology" }
        },
        {
          "id": "BdwYyYmi",
          "_cs": { "value": "Byznys" },
          "_en": { "value": "Business" }
        },
        {
          "id": "4igVHOnN",
          "_cs": { "value": "Marketing" },
          "_en": { "value": "Marketing" }
        }
      ]
    }
  ]
}

results.pages

object

Show child attributes

results.pages.activePage

string | null

ID of active event page (template)

results.createdAt

string<date-time>

Date and time when the event was created

results.updatedAt

string<date-time>

Date and time when the event was last updated

total

integer

Total count of matching events

Introduction Get an event by ID

⌘I

Get Started

Events

Guests

List all events

Authorizations

Query Parameters

Response