> 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

# ListScheduleItems

# Package: eventManagement

# Namespace: ScheduleManagement

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/events/event-management/schedule-items/list-schedule-items.md

## Permission Scopes:
Manage Events: SCOPE.EVENTS.MANAGE-EVENTS

## Introduction

Retrieves a list of up to 100 schedule items, with basic filter support.

Default filters to schedule items with a `state` of `PUBLISHED` and `VISIBLE`.

---

## REST API

### Schema

```
 Method: listScheduleItems
 Description: Retrieves a list of up to 100 schedule items, with basic filter support.  Default filters to schedule items with a `state` of `PUBLISHED` and `VISIBLE`.
 URL: https://www.wixapis.com/events/v1/schedule
 Method: GET
 Method parameters:
   query param name: eventId | type: array<eventId> | description: Event GUID to which the schedule items belong. 
   query param name: facet | type: array<facet> | description: Filter facets. 
   query param name: itemId | type: array<itemId> | description: Item GUIDs filter. 
   query param name: limit | type: limit | description: *Deprecated:** Use `paging` instead. 
   query param name: offset | type: offset | description: *Deprecated:** Use `paging` instead. 
   param name: paging | type: Paging   
        - name: limit | type: integer | description: Number of items to load per page. 
        - name: offset | type: integer | description: Number of items to skip in the current sort order. 
   query param name: stageName | type: array<stageName> | description: Stage names filter. 
   query param name: startingBefore | type: startingBefore | description: Filters schedule items starting before specified point in time. Non-inclusive. 
   query param name: startingFrom | type: startingFrom | description: Filters schedule items starting on or after specified point in time. Inclusive. 
   query param name: state | type: array<state> | description: Schedule item state filter.  Defaults to `["PUBLISHED", "VISIBLE"]` when no filters are specified. <br/> If neither `"PUBLISHED"` nor `"DRAFT"` are specified, assumes `"PUBLISHED"`, for example: [`"HIDDEN"`] becomes [`"HIDDEN"`, `"PUBLISHED"`]. If neither `"VISIBLE"` nor `"HIDDEN"` are specified, assumes `"VISIBLE"`, for example: [`"DRAFT"`] becomes [`"DRAFT"`, `"VISIBLE"`]. 
                 - enum:
                 -     PUBLISHED: Schedule item is published.
                 -     DRAFT: Schedule item is in draft.
                 -     VISIBLE: Schedule item is visible to the event's guests.
                 -     HIDDEN: Schedule item is hidden to the event's guests.
   query param name: tag | type: array<tag> | description: Tags filter. 
 Return type: ListScheduleItemsResponse
  - name: items | type: array<ScheduleItem> | description: Schedule items. 
     - 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: facets | type: Map<string,FacetCounts> | description: Facets. 
     - name: counts | type: object | description: Facet counts aggregated per value. 
  - name: draftNotPublished | type: boolean | description: Whether there are draft changes which have not been published. 
  - name: pagingMetadata | type: PagingMetadataV2 | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: offset | type: integer | description: Offset that was requested. 
     - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. 
     - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. 
     - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 


```

### Examples

### ListScheduleItems
```curl
~~~cURL
curl -X GET 'https://www.wixapis.com/events/v1/agenda' \
-H 'Authorization: <AUTH TOKEN>'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.eventManagement.ScheduleManagement.listScheduleItems(options)
 Description: Retrieves a list of up to 100 schedule items, with basic filter support.  Default filters to schedule items with a `state` of `PUBLISHED` and `VISIBLE`.
 Method parameters:
   param name: options | type: ListScheduleItemsOptions  none 
        - name: eventId | type: array | description: Event GUID to which the schedule items belong. 
        - name: state | type: array<StateFilter> | description: Schedule item state filter.  Defaults to `["PUBLISHED", "VISIBLE"]` when no filters are specified. <br/> If neither `"PUBLISHED"` nor `"DRAFT"` are specified, assumes `"PUBLISHED"`, for example: [`"HIDDEN"`] becomes [`"HIDDEN"`, `"PUBLISHED"`]. If neither `"VISIBLE"` nor `"HIDDEN"` are specified, assumes `"VISIBLE"`, for example: [`"DRAFT"`] becomes [`"DRAFT"`, `"VISIBLE"`]. 
             - enum:
             -     PUBLISHED: Schedule item is published.
             -     DRAFT: Schedule item is in draft.
             -     VISIBLE: Schedule item is visible to the event's guests.
             -     HIDDEN: Schedule item is hidden to the event's guests.
        - name: startingFrom | type: Date | description: Filters schedule items starting on or after specified point in time. Inclusive. 
        - name: startingBefore | type: Date | description: Filters schedule items starting before specified point in time. Non-inclusive. 
        - name: facet | type: array | description: Filter facets. 
        - name: itemId | type: array | description: Item GUIDs filter. 
        - name: tag | type: array | description: Tags filter. 
        - name: stageName | type: array | description: Stage names filter. 
        - name: paging | type: Paging | description: Pointer to page of results using offset. See [Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging.md#paging). 
           - name: limit | type: integer | description: Number of items to load per page. 
           - name: offset | type: integer | description: Number of items to skip in the current sort order. 
 Return type: PROMISE<ListScheduleItemsResponse>
  - name: items | type: array<ScheduleItem> | description: Schedule items. 
     - 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. 
  - name: facets | type: Map<string,FacetCounts> | description: Facets. 
     - name: counts | type: object | description: Facet counts aggregated per value. 
  - name: draftNotPublished | type: boolean | description: Whether there are draft changes which have not been published. 
  - name: pagingMetadata | type: PagingMetadataV2 | description: Paging metadata. 
     - name: count | type: integer | description: Number of items returned in the response. 
     - name: offset | type: integer | description: Offset that was requested. 
     - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. 
     - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. 
     - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. 
        - name: next | type: string | description: Cursor string pointing to the next page in the list of results. 
        - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. 


```

### Examples

### listScheduleItems
```javascript
import { schedule } from '@wix/events';

async function listScheduleItems(options) {
  const response = await schedule.listScheduleItems(options);
};
```

### listScheduleItems (with elevated permissions)
```javascript
import { schedule } from '@wix/events';
import { auth } from '@wix/essentials';

async function myListScheduleItemsMethod(options) {
  const elevatedListScheduleItems = auth.elevate(schedule.listScheduleItems);
  const response = await elevatedListScheduleItems(options);
}
```

### listScheduleItems (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 listScheduleItems(options) {
  const response = await myWixClient.schedule.listScheduleItems(options);
};
```

---