POST

Query Steps


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 steps, given the provided paging, filtering, and sorting.

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

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

For predictable response sizes, we recommend setting paging.limit up to 100.

If your app is already scoped to a specific program, pass programId in addition to the query filters. programId adds program context to the request and doesn't filter the results. To retrieve steps belonging to that program and its sections, include both programId and sectionId in query.filter. Supported sorting fields are createdDate, updatedDate, id, programId, ordering, stepType, and description.title. When sorting by ordering, also filter by sectionId. Use descriptionFieldSet to control how much description content to return. Some returned fields depend on the caller's permissions.

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

PropertyFiltersSort
stepType$eq, $ne, $in, $existsSort: ASC, DESC
description.title$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
sectionId$eq, $inNone
createdDateSort: ASC, DESC
updatedDateSort: ASC, DESC
orderingSort: ASC, DESC
id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
programId$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
Permission Scopes
Manage Online Programs
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/online-programs/v3/steps/query

Errors

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

Did this help?