POST

Query Achievements


Retrieves a list of up to 200 achievements, given the provided paging, filtering, and sorting.

Results are always scoped to the calling account, which is derived from the request's identity.

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

  • createdDate is sorted in DESC order
  • cursorPaging.limit is 50

Supported filter and sort fields: id, points, achievementType.

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

PropertyFiltersSort
id$eq, $ne, $in, $exists, $gt, $gte, $lt, $lte, $startsWithSort: ASC, DESC
points$eq, $ne, $in, $exists, $gt, $gte, $lt, $lteSort: ASC, DESC
achievementType$eq, $ne, $in, $existsSort: ASC, DESC
Authentication

You can only call this method when authenticated as a Wix user or by using an account level API key.

Permissions
SCOPE.PARTNERS.PARTNERS_PROGRAM_READ
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/partners/partnersprogram/v1/partners-program/achievements/query

Errors

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

Did this help?