POST

Query Sections


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

Use this method when you need to filter sections, apply custom sorting or paging, or query across programs. When you know the program ID and need all sections in program order, call List Sections.

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

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

Supported filter fields are programId, id, and delayInDays. Supported sorting fields are id, delayInDays, createdDate, and ordering. When sorting by a field other than programId, also filter by programId. Section extended fields aren't supported for filtering or sorting. Queries that reference them are rejected.

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

PropertyFiltersSort
programId$eqNone
id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
delayInDays$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
createdDateSort: ASC, DESC
orderingSort: ASC, DESC
Permission Scopes
Manage Online Programs
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/online-programs/v3/sections/query

Errors

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

Did this help?