Users

The Users API allows you to retrieve user data from the Deskbird system. The endpoints in this section provide access to multiple users as well as individual user details.

Authentication

All user-related endpoints require authentication via a valid API key in the Authorization header. Ensure that you include a valid API key in your requests.

Endpoints

1. Get Users

Endpoint:
GET /users

Description:
Retrieves a list of users from the system. This endpoint supports pagination to handle large datasets efficiently.

Query Parameters:

limit (integer, optional) – Specifies the maximum number of users returned per request.

offset (integer, optional) – Defines the starting point for retrieving users, allowing pagination.

Headers:

Example Request:

2. Get Single User

Endpoint:
GET /users/{userId}

Description:
Retrieves details of a specific user by their unique userId.

URL Parameters:

userId (string, required) – The unique identifier of the user whose details are being fetched.

Headers:

Example Request:

By using the Users API, you can efficiently manage users while ensuring secure access through token-based authentication.

Authentication#

Endpoints#

1. Get Users#

2. Get Single User#

Authentication

Endpoints

1. Get Users

2. Get Single User