Skip to main content
GET
/
users
cURL
curl --request GET \
  --url https://api.yourjobsearchgenius.ai/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "_id": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "uniqueUserId": "<string>",
      "accountStatus": "active",
      "onboardingCompleted": true,
      "lastLoginDate": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "autoLoginUrl": "<string>"
    }
  ],
  "pagination": {
    "totalCount": 123,
    "totalPages": 123,
    "currentPage": 123,
    "limit": 123,
    "hasNextPage": true,
    "hasPrevPage": true,
    "nextPage": 123,
    "prevPage": 123,
    "nextUrl": "<string>",
    "prevUrl": "<string>"
  },
  "success": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer<int32>
default:1

Page number (default: 1)

limit
integer<int32>
default:10

Number of records per page (default: 10)

email
string

Search by user email

userId
string

Search by user ID

uniqueUserId
string

Search by unique user ID

accountStatus
enum<string>

Filter by account status

Available options:
active,
inactive
onboardingCompleted
boolean

Filter by onboarding completion status

lastLoginDateFrom
string<date-time>

Filter by last login date range (ISO format)

lastLoginDateTo
string<date-time>

Filter by last login date range (ISO format)

createdAtFrom
string<date-time>

Filter by creation date range (ISO format)

createdAtTo
string<date-time>

Filter by creation date range (ISO format)

lastLoginDaysAgo
integer<int32>

Filter users who logged in X days ago

hasNoContacts
boolean

Filter users with no contacts

hasNoDocuments
boolean

Filter users with no cover letters

hasNoResumes
boolean

Filter users with no resumes

hasNoJobTracking
boolean

Filter users with no tracked jobs

hasNoMockInterviews
boolean

Filter users with no mock interviews

hasNoInterviewResponses
boolean

Filter users with no interview responses

hasNoOfferNegotiations
boolean

Filter users with no offer negotiations

Response

Users response with pagination

data
object[]
required

Array of user objects

pagination
object
required
success
boolean
required

Indicates if the request was successful