POST

Query OAuth Apps

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

Query OAuth Apps runs with these defaults, which you can override:

  • Results are sorted by id in descending order.
  • paging.offset is 0.

For field support for filters and sorting, see OAuth Apps: Supported Filters and Sorting

To learn about working with Query endpoints in general, see API Query Language.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Headless Manage
Manage OAuth Apps
Read OAuth Apps
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/oauth-app/v1/oauth-apps/query
Body Params
queryQuery

Query options.

Response Object
oAuthAppsArray <OAuthApp>

List of OAuth apps matching the query.

pagingMetadataPagingMetadata

Paging metadata.

Query for OAuth apps
Request
cURL
curl -X POST \
'https://www.wixapis.com/oauth-app/v1/oauth-apps/query' \
-H 'Authorization: <AUTH> \
-H 'Content-Type: application/json' \
-d '{
  "query": {
    "sort": []
  }
}'
Response
JSON
{
  "oAuthApps": [
    {
      "id": "adddb436-aa2c-474a-8f0e-af719f3acd5b",
      "createdDate": "2023-03-28T13:43:48.959Z",
      "name": "Test app",
      "description": "Some test app",
      "allowedRedirectDomains": ["www.my-test-site.com"],
      "allowedRedirectUris": []
    }
  ],
  "pagingMetadata": {
    "count": 1,
    "offset": 0,
    "total": 1,
    "tooManyToCount": false,
    "hasNext": false
  }
}
Errors

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

Did this help?