listScheduleItems( )

Retrieves a list of up to 100 schedule items

Syntax

function listScheduleItems(options: ListScheduleItemsOptions): Promise<ListScheduleItemsResponse>

listScheduleItems Parameters

NAME

TYPE

DESCRIPTION

options

Optional

ListScheduleItemsOptions

Optional fields.

Returns

Return Type:

Promise<

ListScheduleItemsResponse

NAME

TYPE

DESCRIPTION

draftNotPublished

boolean

Whether there are draft changes which have not been published yet. Returned only when filtering by single event_id with WIX_EVENTS.MANAGE_AGENDA permission.

facets

Record<

string

FacetCounts

Facets.

items

Array<

ScheduleItem

Schedule items.

limit

number

Deprecated. Limit.

offset

number

Deprecated, use paging_metadata.offset. Offset.

pagingMetadata

PagingMetadataV2

Paging metadata.

total

number

Deprecated, use paging_metadata.total. Total schedule items matching the given filters.

Was this helpful?

listScheduleItems example

Copy Code

1import { schedule } from 'wix-events.v2';
2  
3 async function listScheduleItems(options) {
4   try {
5     const result = await schedule.listScheduleItems(options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13