Get Customer

Get Customer by ID

curl --request GET \
  --url https://api.yourjobsearchgenius.ai/v1/customers/{_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "_id": "507f1f77bcf86cd799439011",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "accountStatus": "active",
    "onboardingCompleted": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "subscriptionId": "sub_123456789",
    "subscriptionStatus": "active",
    "autoLogin": {
      "autoLoginUrl": "https://app.yourjobsearchgenius.ai/auto-login?code=abc123",
      "autoLoginCode": "abc123"
    },
    "engagementStats": {
      "resumesCount": 5,
      "interviewsCount": 8,
      "jobTracking": {
        "totalJobs": 30,
        "statusBreakdown": {
          "applied": 15,
          "interviewing": 5,
          "offered": 2,
          "rejected": 8
        }
      },
      "mockInterviews": {
        "totalInterviews": 8,
        "interviews": [
          {
            "_id": "507f1f77bcf86cd799439013",
            "title": "Software Engineer Interview",
            "stageType": "technical",
            "difficulty": "medium",
            "isCompleted": true,
            "createdAt": "2024-01-10T14:30:00Z",
            "takeCount": 3,
            "averageScore": 82.3,
            "allTakes": [
              {
                "_id": "507f1f77bcf86cd799439012",
                "title": "Software Engineer Interview",
                "stageType": "technical",
                "difficulty": "medium",
                "isCompleted": true,
                "createdAt": "2024-01-10T14:30:00Z",
                "score": 85.5
              }
            ]
          }
        ]
      },
      "offerNegotiationsCount": 2,
      "contactsCount": 12,
      "coverLettersCount": 7
    },
    "lastLoginDate": "2024-01-15T10:30:00Z",
    "subscriptionPackageName": "Premium Plan",
    "subscriptionFrequency": "monthly",
    "subscriptionCurrentPeriodEnd": "2024-02-01T00:00:00Z"
  },
  "success": true
}

GET

customers

{_id}

Get Customer by ID

curl --request GET \
  --url https://api.yourjobsearchgenius.ai/v1/customers/{_id} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "_id": "507f1f77bcf86cd799439011",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "accountStatus": "active",
    "onboardingCompleted": true,
    "createdAt": "2024-01-01T00:00:00Z",
    "subscriptionId": "sub_123456789",
    "subscriptionStatus": "active",
    "autoLogin": {
      "autoLoginUrl": "https://app.yourjobsearchgenius.ai/auto-login?code=abc123",
      "autoLoginCode": "abc123"
    },
    "engagementStats": {
      "resumesCount": 5,
      "interviewsCount": 8,
      "jobTracking": {
        "totalJobs": 30,
        "statusBreakdown": {
          "applied": 15,
          "interviewing": 5,
          "offered": 2,
          "rejected": 8
        }
      },
      "mockInterviews": {
        "totalInterviews": 8,
        "interviews": [
          {
            "_id": "507f1f77bcf86cd799439013",
            "title": "Software Engineer Interview",
            "stageType": "technical",
            "difficulty": "medium",
            "isCompleted": true,
            "createdAt": "2024-01-10T14:30:00Z",
            "takeCount": 3,
            "averageScore": 82.3,
            "allTakes": [
              {
                "_id": "507f1f77bcf86cd799439012",
                "title": "Software Engineer Interview",
                "stageType": "technical",
                "difficulty": "medium",
                "isCompleted": true,
                "createdAt": "2024-01-10T14:30:00Z",
                "score": 85.5
              }
            ]
          }
        ]
      },
      "offerNegotiationsCount": 2,
      "contactsCount": 12,
      "coverLettersCount": 7
    },
    "lastLoginDate": "2024-01-15T10:30:00Z",
    "subscriptionPackageName": "Premium Plan",
    "subscriptionFrequency": "monthly",
    "subscriptionCurrentPeriodEnd": "2024-02-01T00:00:00Z"
  },
  "success": true
}

Authorizations

Authorization

string

header

required

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

Path Parameters

_id

string

required

The customer's unique identifier

Example:

"507f1f77bcf86cd799439011"

Response

Customer details response

data

object

required

Show child attributes

data._id

string

required

ID of the customer (MongoDB ObjectId)

Example:

"507f1f77bcf86cd799439011"

data.firstName

string

required

The first name of the customer.

Example:

"John"

data.lastName

string

required

The last name of the customer.

Example:

"Doe"

data.email

string

required

Email address of the customer.

Example:

"[email protected]"

data.accountStatus

enum<string>

required

Current status of the customer account

Available options:

active,

inactive

Example:

"active"

data.onboardingCompleted

boolean

required

Whether the customer has completed onboarding

Example:

true

data.createdAt

string<date-time>

required

Date and time when the customer account was created

Example:

"2024-01-01T00:00:00Z"

data.subscriptionId

string

required

Subscription ID in our system

Example:

"sub_123456789"

data.subscriptionStatus

enum<string>

required

Current status of the customer's subscription

Available options:

active,

inactive,

cancelled,

expired

Example:

"active"

Show child attributes

The auto login URL for the customer.

Example:

"https://app.yourjobsearchgenius.ai/auto-login?code=abc123"

The auto login code for the customer.

Example:

"abc123"

data.engagementStats

object

required

Show child attributes

data.engagementStats.resumesCount

integer

required

Total number of resumes

Example:

5

data.engagementStats.interviewsCount

integer

required

Total number of interviews

Example:

8

data.engagementStats.jobTracking

object

required

Show child attributes

data.engagementStats.jobTracking.totalJobs

integer

required

Total number of tracked jobs

Example:

30

data.engagementStats.jobTracking.statusBreakdown

object

required

Show child attributes

data.engagementStats.jobTracking.statusBreakdown.applied

integer

required

Number of jobs applied to

Example:

15

data.engagementStats.jobTracking.statusBreakdown.interviewing

integer

required

Number of jobs in interviewing stage

Example:

5

data.engagementStats.jobTracking.statusBreakdown.offered

integer

required

Number of job offers received

Example:

2

data.engagementStats.jobTracking.statusBreakdown.rejected

integer

required

Number of job rejections

Example:

8

data.engagementStats.mockInterviews

object

required

Show child attributes

data.engagementStats.mockInterviews.totalInterviews

integer

required

Total number of mock interviews

Example:

8

data.engagementStats.mockInterviews.interviews

object[]

required

Array of mock interview objects

Show child attributes

data.engagementStats.mockInterviews.interviews._id

string

required

ID of the mock interview

Example:

"507f1f77bcf86cd799439013"

data.engagementStats.mockInterviews.interviews.title

string

required

Title of the interview

Example:

"Software Engineer Interview"

data.engagementStats.mockInterviews.interviews.stageType

string

required

Type of interview stage

Example:

"technical"

data.engagementStats.mockInterviews.interviews.difficulty

string

required

Difficulty level of the interview

Example:

"medium"

data.engagementStats.mockInterviews.interviews.isCompleted

boolean

required

Whether the interview is completed

Example:

true

data.engagementStats.mockInterviews.interviews.createdAt

string<date-time>

required

Date when the interview was created

Example:

"2024-01-10T14:30:00Z"

data.engagementStats.mockInterviews.interviews.takeCount

integer

required

Number of times this interview was taken

Example:

3

data.engagementStats.mockInterviews.interviews.averageScore

number

required

Average score across all takes

Example:

82.3

data.engagementStats.mockInterviews.interviews.allTakes

object[]

required

Array of all interview takes

Show child attributes

data.engagementStats.mockInterviews.interviews.allTakes._id

string

required

ID of the interview take

Example:

"507f1f77bcf86cd799439012"

data.engagementStats.mockInterviews.interviews.allTakes.title

string

required

Title of the interview

Example:

"Software Engineer Interview"

data.engagementStats.mockInterviews.interviews.allTakes.stageType

string

required

Type of interview stage

Example:

"technical"

data.engagementStats.mockInterviews.interviews.allTakes.difficulty

string

required

Difficulty level of the interview

Example:

"medium"

data.engagementStats.mockInterviews.interviews.allTakes.isCompleted

boolean

required

Whether the interview is completed

Example:

true

data.engagementStats.mockInterviews.interviews.allTakes.createdAt

string<date-time>

required

Date when the interview was created

Example:

"2024-01-10T14:30:00Z"

data.engagementStats.mockInterviews.interviews.allTakes.score

number

required

Score achieved in this take

Example:

85.5

data.engagementStats.offerNegotiationsCount

integer

required

Total number of offer negotiations

Example:

2

data.engagementStats.contactsCount

integer

required

Total number of contacts

Example:

12

data.engagementStats.coverLettersCount

integer

required

Total number of cover letters

Example:

7

Date and time of the customer's last login

Example:

"2024-01-15T10:30:00Z"

data.subscriptionPackageName

string

Name of the subscription package

Example:

"Premium Plan"

data.subscriptionFrequency

enum<string>

Billing frequency of the subscription

Available options:

monthly,

yearly,

weekly,

daily

Example:

"monthly"

data.subscriptionCurrentPeriodEnd

string<date-time>

End date of the current subscription period

Example:

"2024-02-01T00:00:00Z"

success

boolean

required

Indicates if the request was successful

Example:

true

Get All Customers Create Customer

⌘I

Get Started

Reseller

Reseller - Customers

Reseller - Packages

Reseller - Invoices

Institution

Institution - Users

Resources

Authorizations

Path Parameters

Response