POST

Query Programs


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 a list of up to 50 programs, given the provided paging, filtering, and sorting.

Query Programs runs with these defaults, which you can override:

  • createdDate is sorted in DESC order.
  • paging.limit is 50.
  • paging.offset is 0.

To learn about working with Query methods, see API Query Language, Sorting and Paging, and Field Projection.

Results are visibility-filtered according to the caller identity.

PropertyFiltersSort
id$eq, $inSort: ASC, DESC
status$eq, $inSort: ASC, DESC
categoryIds$hasAll, $hasSome, $isEmptyNone
seo.slug$eqSort: ASC, DESC
createdDateSort: ASC, DESC
statusUpdatedDateSort: ASC, DESC
socialGroupId$eq, $inNone
timeline.selfPaced$eqNone
price$existsNone
restrictions.accessType$inNone
description.titleSort: ASC, DESC
Permissions
Wix Multilingual - Nile Wrapper Domain Events Read
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/_api/programs-service/v3/programs/query

Errors

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

Did this help?