Get a User

This endpoint allows you to get user data of an organisation

1. Get User Data using userId

Get User Data

get

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Path parameters

userIdanyRequired

User ID

Responses

200

Success

application/json

userIdstringRequired

orgIdstringRequired

orgAliasstringRequired

firstNamestringRequired

lastNamestringOptionalDefault: ""

professionstringOptionalDefault: ""

emailstringRequired

phonestringOptionalDefault: ""

deletedbooleanRequiredDefault: false

firebaseDeviceTokensstring[]OptionalDefault: []

userCreditsBalancenumberRequiredDefault: 0

platformstringRequiredDefault: ""

createdAtstringRequired

lastUsedAtstringOptional

404

Organisation not found

get

/api/v1/user/{userId}

HTTPcURLJavaScriptPython

GET /api/v1/user/{userId} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "userId": "text",
  "orgId": "text",
  "orgAlias": "text",
  "firstName": "text",
  "lastName": "",
  "profession": "",
  "email": "text",
  "phone": "",
  "deleted": false,
  "firebaseDeviceTokens": [
    "text"
  ],
  "userCreditsBalance": 0,
  "platform": "",
  "createdAt": "text",
  "lastUsedAt": "text"
}

2. Get User using emailId

Get User Data by Email

post

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Body

application/json

emailstringRequired

orgIdstringRequired

Responses

200

User fetched successfully

application/json

userIdstringRequired

orgIdstringRequired

orgAliasstringRequired

firstNamestringRequired

lastNamestringOptionalDefault: ""

professionstringOptionalDefault: ""

emailstringRequired

phonestringOptionalDefault: ""

deletedbooleanRequiredDefault: false

firebaseDeviceTokensstring[]OptionalDefault: []

userCreditsBalancenumberRequiredDefault: 0

platformstringRequiredDefault: ""

createdAtstringRequired

lastUsedAtstringOptional

400

Bad request

409

Conflict

post

/api/v1/user/email

HTTPcURLJavaScriptPython

POST /api/v1/user/email HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "email": "text",
  "orgId": "text"
}

{
  "userId": "text",
  "orgId": "text",
  "orgAlias": "text",
  "firstName": "text",
  "lastName": "",
  "profession": "",
  "email": "text",
  "phone": "",
  "deleted": false,
  "firebaseDeviceTokens": [
    "text"
  ],
  "userCreditsBalance": 0,
  "platform": "",
  "createdAt": "text",
  "lastUsedAt": "text"
}