GET

List Schedule Items


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

Endpoint
GET
https://www.wixapis.com/events/v1/schedule

Query Params
eventIdArray <string>

Event ID.


stateArray <string>

Schedule item state filter. Defaults to [PUBLISHED, VISIBLE] when no filters are specified. 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].


startingFromstring

Filters schedule items starting on or after specified point in time. Inclusive.


startingBeforestring

Filters schedule items starting before specified point in time. Non-inclusive.


offsetintegerdeprecated

Deprecated, use paging. Number of items to skip. See Pagination.


limitintegerdeprecated

Deprecated, use paging. Number of items to load per page. See Pagination.


facetArray <string>

Filter facets. See supported facets.


itemIdArray <string>

Item IDs filter.


tagArray <string>

Tags filter.


stageNameArray <string>

Stage names filter.


paging.limitintegerminimum 0maximum 1000format int32

Number of items to load per page.


paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.

Response Object
totalintegerdeprecated

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


limitintegerdeprecated

Deprecated. Limit.


offsetintegerdeprecated

Deprecated, use paging_metadata.offset. Offset.


itemsArray <ScheduleItem>

Schedule items.


facetsMap <string, FacetCounts>format map

Facets.


draftNotPublishedboolean

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.


pagingMetadataPagingMetadata
List Schedule Items Example 1
Request
cURL
curl -X GET 'https://www.wixapis.com/events/v1/agenda' \ -H 'Authorization: <AUTH TOKEN>'
Response
JSON
{}
Errors

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

Did this help?