Get Users

Retrieve a list of users based on pagination limits. This endpoint allows for fetching multiple user details in a paginated format.

GET

    https://api.deadsimplechat.com/consumer/api/v2/users

Request

GET /consumer/api/v2/users

info

The auth query parameter is your private key. You can find it in your Dashboard under Developer -> Private Key.

Query Parameters

Parameter	Description	Data Type	Default	Maximum Value
auth	Go to Dashboard -> Developer -> Private Key is your auth	String	-	-
limit	The number of users to return (pagination limit)	Number	50	200
skip	The number of users to skip (pagination offset)	Number	0	-

Responses

Success Response

A JSON object containing the total number of users, the limit and skip parameters for pagination, and an array of user data.

HTTP Status: 200 OK

Body:

{
  "total": 500,
  "limit": 50,
  "skip": 0,
  "data": [
    {
      "username": "sample username",
      "profilePic": "sample profile picture URL",
      // ...other user fields
    },
    // ...more users
  ]
}

Error Responses

• Limit exceeds the maximum value:

  HTTP Status: 400 Bad Request

  Body:

  {
      "error": true,
      "message": "limit should be less than 200"
  }

• Invalid API Key:

  HTTP Status: 401 Unauthorized

  Body:

  {
      "error": "Invalid API Key"
  }

• No API Key Specified:

  HTTP Status: 400 Bad Request

  Body:

  {
      "error": "Please specify API Key"
  }

Code Examples

JavaScript (Fetch API)

fetch("https://api.deadsimplechat.com/consumer/api/v2/users?auth=<YOUR_SECRET_KEY>&limit=<LIMIT>&skip=<SKIP>")