GET
/
v1
/
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"
                }
              }
            ]
          }
        ]
      },
      "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

200
application/json

Events retrieved successfully.

The response is of type object.