Get User

Retrieve details of a user using their unique user identifier.

GET

    https://api.deadsimplechat.com/consumer/api/v2/user/:uniqueUserIdentifier

Request

GET /consumer/api/v2/user/:uniqueUserIdentifier

info

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

Path Parameters

Parameter	Description	Data Type
uniqueUserIdentifier	The unique identifier of the user	String

Query Parameters

Parameter	Description	Data Type
auth	Go to Dashboard -> Developer -> Private Key is your auth	String

Responses

Success Response

A JSON object details of the user.

HTTP Status: 200 OK

Body:

{
  "username": "sample username",
  "profilePic": "sample profile picture URL",
  "profilePicKey": "sample profile picture key",
  "created": "2023-01-01T00:00:00.000Z",
  "updated": "2023-01-02T00:00:00.000Z",
  "meta": "sample meta information",
  "firstName": "sample first name",
  "lastName": "sample last name",
  "lastSeen": "2023-01-03T00:00:00.000Z",
  "lastChatRoomId": "sample last chat room ID",
  "provisioned": true
}

Error Responses

• User not found:

  HTTP Status: 400 Bad Request

  Body:

  {
      "message": "user not found"
  }

Code Examples

JavaScript (Fetch API)

fetch("https://api.deadsimplechat.com/consumer/api/v2/user/<UNIQUE_USER_IDENTIFIER>?auth=<YOUR_SECRET_KEY>")