API Endpoints: Users Retrieval

This section provides detailed information about the users retrieval API endpoints available on our platform.

Overview

The /en/developer/api_endpoints/users_retrieval endpoint is designed to allow developers to retrieve information about users from the system. This endpoint can be used to fetch user details, user activity logs, or any other relevant user-related data.

Endpoint Details

GET /users

Retrieves a list of users. This endpoint accepts query parameters to filter and sort the results.

Query Parameters:
- page: The page number for pagination.
- limit: The number of users to return per page.
- sort_by: The field to sort the results by.
- order: The order of sorting (asc or desc).

GET /users/{user_id}

Retrieves detailed information about a specific user by their user ID.

Path Parameter:
- user_id: The unique identifier for the user.

Usage Example

Here's an example of how to use the /users endpoint to retrieve a list of users:

curl -X GET "https://api.example.com/users?page=1&limit=10&sort_by=created_at&order=desc"

To retrieve information about a specific user:

curl -X GET "https://api.example.com/users/12345"