ByteRaven
  • 👋Welcome
  • Start a Project
  • Explore All Modules
  • User
    • 💡Introduction
    • Create a User
    • Get JWT for a User
    • Get a User
    • Update User Data
    • Deleting a User
  • SKILLS
    • 💡Introduction
    • Get Skills
    • Creating Skills
    • Update Skills
    • Delete Skills
  • Job Roles
    • 💡Introduction
    • Get Job Roles
    • Create Job Roles
    • Update Job Roles
    • Delete Job Roles
  • Candidate Profile
    • 💡Introduction
    • Get Candidate Profile
    • Create Candidate Profile
    • Generate Candidate Profile from Resume Transcript
  • Resume
    • 💡Introduction
    • Get Resume PDF Transcript
    • Create Resume Iteration (Analysis)
    • Get Resume Iteration/s
    • Get Resume Insights
    • Stream Resume Chat (SSE)
    • Save a Resume Chat Message
    • Get Resume Chat Messages
    • Create a Resume Template
    • Get Resume Templates
    • Build a Resume PDF
    • Get All Resume PDF Builds
  • Flash Cards
    • 💡Introduction
    • Create a Flash Card
    • Get Flash Cards
    • Update a Flash Card
    • Delete a Flash Card
    • Create Flash Card Status for a User
    • Get Flash Card Status for a User
    • Updating Flash Card Status for a User
    • Deleting Flash Cards Status for a User for that skill keyword
    • Bookmark / Unbookmark a Flash Card
    • Get Bookmarked Flash Cards for a User
  • Interview
    • 💡Introduction
    • Get Interview Templates
    • Create an Interview Template
    • Update Interview Template
    • Delete Interview Template
    • Create an Interview
    • Get Interview Data
    • Create Interview Message
    • Interview Question/Answer File Type Conversion
    • Update Interview Message
    • Get Interview Messages Data
    • Create Interview Report
    • Get Interview Report
  • Help & Support
    • Contact Us
Powered by GitBook
On this page
  1. User

Get a User

This endpoint allows you to get user data of an organisation

PreviousGet JWT for a UserNextUpdate User Data

Last updated 8 months ago

1. Get User Data using userId

2. Get User using emailId

Get User Data

get
Authorizations
Path parameters
userIdanyRequired

User ID

Responses
200
Success
application/json
404
Organisation not found
get
GET /api/v1/user/{userId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "userId": "text",
  "orgId": "text",
  "orgAlias": "text",
  "firstName": "text",
  "lastName": "text",
  "profession": "text",
  "email": "text",
  "phone": "text",
  "deleted": true,
  "firebaseDeviceTokens": [
    "text"
  ],
  "userCreditsBalance": 1,
  "platform": "text",
  "createdAt": "text",
  "lastUsedAt": "text"
}
  • 1. Get User Data using userId
  • GETGet User Data
  • 2. Get User using emailId
  • POSTGet User Data by Email

Get User Data by Email

post
Authorizations
Body
emailstringRequired
orgIdstringRequired
Responses
200
User fetched successfully
application/json
400
Bad request
409
Conflict
post
POST /api/v1/user/email HTTP/1.1
Host: 
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": "text",
  "profession": "text",
  "email": "text",
  "phone": "text",
  "deleted": true,
  "firebaseDeviceTokens": [
    "text"
  ],
  "userCreditsBalance": 1,
  "platform": "text",
  "createdAt": "text",
  "lastUsedAt": "text"
}