> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetScheduleItem # Package: eventManagement # Namespace: ScheduleManagement # Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/event-management/schedule-items/get-schedule-item.md ## Permission Scopes: Manage Events: SCOPE.EVENTS.MANAGE-EVENTS ## Introduction Retrieves a schedule item. --- ## REST API ### Schema ``` Method: getScheduleItem Description: Retrieves a schedule item. URL: https://www.wixapis.com/events/v1/schedule/{itemId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: itemId Method parameters: query param name: eventId | type: eventId | description: Event GUID to which the schedule item belongs. query param name: includeDraft | type: includeDraft | description: Whether to include draft schedule items in the response. param name: itemId | type: none | required: true Return type: GetScheduleItemResponse - name: item | type: ScheduleItem | description: Schedule item. - name: id | type: string | description: Schedule item GUID. - name: hidden | type: boolean | description: Whether a schedule item is hidden from guests. - name: name | type: string | description: Schedule item name. - name: timeSlot | type: TimeInterval | description: Time slot of a schedule item. - name: start | type: string | description: Start of the time slot interval, inclusive. - name: end | type: string | description: End of the time slot interval, exclusive. - name: timeZoneId | type: string | description: Time zone GUID in TZ database format, e.g., `"EST"`, `"America/Los_Angeles"`. Defaults to `"Etc/UTC"` when not set. - name: description | type: string | description: Rich text schedule item description. - name: stageName | type: string | description: Stage or room name in which a session takes place. - name: tags | type: array | description: Schedule item tags. Used to organize the items by a theme. - name: status | type: ScheduleStatus | description: Schedule item status. - enum: - SCHEDULED: Item is scheduled for a future date. - CANCELED: Item is canceled. - name: createdDate | type: string | description: Date and time the schedule item was created. - name: updatedDate | type: string | description: Date and time the schedule item was updated. - name: eventId | type: string | description: Event GUID to which the schedule item belongs. - name: draft | type: boolean | description: Whether the schedule item is a draft. - name: draft | type: ScheduleItem | description: Draft of the schedule item. ``` ### Examples ### GetScheduleItem ```curl ~~~cURL curl -X GET 'https://www.wixapis.com/events/v1/agenda/80a28db1-672b-45db-a62c-5315ee07ae22' \ -H 'Authorization: ' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.eventManagement.ScheduleManagement.getScheduleItem(itemId, options) Description: Retrieves a schedule item. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: itemId Method parameters: param name: itemId | type: string | description: Schedule item GUID. | required: true param name: options | type: GetScheduleItemOptions none - name: eventId | type: string | description: Event GUID to which the schedule item belongs. - name: includeDraft | type: boolean | description: Whether to include draft schedule items in the response. Return type: PROMISE - name: _id | type: string | description: Schedule item GUID. - name: hidden | type: boolean | description: Whether a schedule item is hidden from guests. - name: name | type: string | description: Schedule item name. - name: timeSlot | type: TimeInterval | description: Time slot of a schedule item. - name: start | type: Date | description: Start of the time slot interval, inclusive. - name: end | type: Date | description: End of the time slot interval, exclusive. - name: timeZoneId | type: string | description: Time zone GUID in TZ database format, e.g., `"EST"`, `"America/Los_Angeles"`. Defaults to `"Etc/UTC"` when not set. - name: description | type: string | description: Rich text schedule item description. - name: stageName | type: string | description: Stage or room name in which a session takes place. - name: tags | type: array | description: Schedule item tags. Used to organize the items by a theme. - name: status | type: ScheduleStatus | description: Schedule item status. - enum: - SCHEDULED: Item is scheduled for a future date. - CANCELED: Item is canceled. - name: _createdDate | type: Date | description: Date and time the schedule item was created. - name: _updatedDate | type: Date | description: Date and time the schedule item was updated. - name: eventId | type: string | description: Event GUID to which the schedule item belongs. - name: draft | type: boolean | description: Whether the schedule item is a draft. ``` ### Examples ### getScheduleItem ```javascript import { schedule } from '@wix/events'; async function getScheduleItem(itemId,options) { const response = await schedule.getScheduleItem(itemId,options); }; ``` ### getScheduleItem (with elevated permissions) ```javascript import { schedule } from '@wix/events'; import { auth } from '@wix/essentials'; async function myGetScheduleItemMethod(itemId,options) { const elevatedGetScheduleItem = auth.elevate(schedule.getScheduleItem); const response = await elevatedGetScheduleItem(itemId,options); } ``` ### getScheduleItem (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { schedule } from '@wix/events'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { schedule }, // Include the auth strategy and host as relevant }); async function getScheduleItem(itemId,options) { const response = await myWixClient.schedule.getScheduleItem(itemId,options); }; ``` ---