This section provides a detailed explanation of the query parameters available in our API. Query parameters are used to pass additional information to the API endpoints, allowing for more flexible and powerful requests.

Common Query Parameters

Here is a list of commonly used query parameters in our API:

  • limit: Limits the number of results returned by the API. For example, limit=10 will return only 10 results.
  • offset: Skips a specified number of records before starting to return results. For example, offset=20 will start returning results from the 21st record.
  • sort: Specifies the sorting order of the results. For example, sort=name,asc will sort the results by name in ascending order.
  • fields: Specifies the fields to be returned in the response. For example, fields=name,email will return only the name and email fields.

Usage Example

To retrieve a list of users with their name and email, you can use the following query parameters:

GET /api/users?fields=name,email

Related Links

For more information on our API, please visit our API Documentation.

API Documentation