GET

Get Event


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves an event.

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Read Bookings Calendar Availability
Read bookings calendar - including participants
Read Bookings Calendar
Manage Calendars
Read Calendar - Including PI
Read Calendar
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/calendar/v3/events/{eventId}

Path Params
eventIdstringRequired

ID of the event to retrieve.

Min: 36 characters Max: 250 characters

Query Params
timeZonestring

Time zone in IANA tz database format for calculating adjustedStart and adjustedEnd. For example, America/New_York or UTC.

Default: timeZone specified in the business site properties.


fieldsArray <string>

Information about which fields containing personal data to return. Refer to the permissions article for more information.

Supported values:

  • PI_FIELDS: Returns all fields with personal data. Your app must have Read Calendars - Including PI or Manage Calendars permission scope.
  • OWN_PI_FIELDS: Returns only fields containing your own personal data.

Max: 1 field Default: No personal data is returned.

Response Object
eventEvent

Retrieved event.

Get Event
Request
cURL
curl -X GET \ 'https://www.wixapis.com/calendar/v3/events/VYAN5iNZkOn1SQ5LLJVWXxdGqRfcnyxpZ2STCAr7l6RswqhNAvAXfO7o59cEoDfhwVTtXUIhN6JM5bb7MDprhwwf3DPqQ6CBgry0qfF6OfXn1tEEqMcwPA' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "event": { "id": "VYAN5iNZkOn1SQ5LLJVWXxdGqRfcnyxpZ2STCAr7l6RswqhNAvAXfO7o59cEoDfhwVTtXUIhN6JM5bb7MDprhwwf3DPqQ6CBgry0qfF6OfXn1tEEqMcwPA", "scheduleId": "132db383-1378-4903-820b-4eebf4242de2", "externalScheduleId": "4187d1f3-38a2-4cfd-b8f1-6333cd012e33", "scheduleName": "Hip Hop Groove", "type": "CLASS", "status": "CONFIRMED", "title": "Hip Hop Groove", "start": { "localDate": "2024-10-07T11:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T10:00:00Z" }, "end": { "localDate": "2024-10-07T12:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T11:00:00Z" }, "adjustedStart": { "localDate": "2024-10-07T11:00:00", "timeZone": "Europe/Dublin" }, "adjustedEnd": { "localDate": "2024-10-07T12:00:00", "timeZone": "Europe/Dublin" }, "timeZone": "Europe/Dublin", "recurrenceType": "INSTANCE", "recurrenceRule": { "frequency": "WEEKLY", "interval": 1, "days": ["MONDAY"] }, "recurringEventId": "132db38313784903820b4eebf4242de24cb655131b0f4f359b7345e7daabb34d", "transparency": "OPAQUE", "location": { "type": "BUSINESS" }, "resources": [ { "id": "76570209-101f-409b-af97-b445bdb63125", "name": "Staff Member #1", "type": "1cd44cf8-756f-41c3-bd90-3e2ffcaf1155", "scheduleId": "e73bf671-bb59-4488-8d1f-afcf0ebe8d27", "transparency": "OPAQUE", "permissionRole": "WRITER" } ], "totalCapacity": 50, "remainingCapacity": 50, "inheritedFields": [ "TITLE", "CAPACITY", "LOCATION", "TIME_ZONE", "CONFERENCING_DETAILS", "RESOURCES", "PARTICIPANTS", "TIME" ], "appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97", "permissions": [], "revision": "1", "createdDate": "2024-10-06T17:16:36.117Z", "updatedDate": "2024-10-06T17:16:36.117Z" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?