Get All Users Info

This route is restricted to Super Admin access only.

Get All Users

This endpoint retrieves a comprehensive list of all users who have subscribed to the platform's newsletter or updates. This is an administrative endpoint and requires an Admin API key for access.

🚧

This route is restricted to Super Admin access only.

Endpoint

HTTP

GET /api/v1/users

Authentication

Type	Required	Location	Description
API Key	true	Header	The key must be sent as x-api-key: Super_ADMIN_KEY.

This endpoint is restricted to administrators. You must provide the master ADMIN_KEY to successfully authenticate the request.

---

Request

This endpoint does not require a request body or any URL parameters.

Example Request

Here is an example of how to call this endpoint using cURL. Replace YOUR_ADMIN_KEY with your actual Super admin API key.

Bash

curl -X GET 'https://offers.dataoorts.com/api/v1/users' \
-H 'x-api-key: YOUR_ADMIN_KEY'

---

Responses

✅ Success Response (200 OK)

A successful request will return an HTTP 200 OK status code and a JSON array of user objects.

Body

The body will be an array, where each object represents a single subscribed user.

JSON

[
  {
    "_id": "CUS_07022024222001729",
    "name": "Srinivasa Ramanujan",
    "email": "[email protected]",
    "phone": "[phone]",
    "registered_at": "2024-05-20T14:30:00.123Z"
  },
  {
    "_id": "CUS_08032024101555890",
    "name": "Richard Phillips Feynman",
    "email": "[email protected]",
    "registered_at": "2024-05-19T09:00:00.456Z"
  }
]

Field Descriptions:

Field	Type	Description
_id	string	The unique identifier for the user.
name	string	The full name provided by the user.
email	string	The user's email address.
phone	string	The user's phone number. This field may be absent.
registered_at	string	The ISO 8601 timestamp of when the user subscribed.

❌ Error Response (401 Unauthorized)

This response is returned if the x-api-key header is missing, invalid, or does not belong to an administrator.

Body

JSON

{
  "error": "Unauthorized"
}

❗️

More than three failed attempts will result in a permanent IP block.

❌ Error Response (500 Internal Server Error)

This response indicates a problem on the server, such as a database connection error or an unexpected exception during processing.

Body

JSON

{
  "error": "A database error occurred",
  "details": "Specific error message from the database driver."
}