Get All Customers

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

{
  "data": [
    {
      "_id": "customer_id",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "subscriptionId": "subscription_id"
    }
  ],
  "pagination": {
    "totalCount": 150,
    "totalPages": 15,
    "currentPage": 1,
    "limit": 10,
    "hasNextPage": true,
    "hasPrevPage": false,
    "nextPage": 2,
    "prevPage": null,
    "nextUrl": "https://api.com/v1/customers?page=2&limit=10",
    "prevUrl": null
  },
  "success": true
}

GET

customers

Get All Customers

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

{
  "data": [
    {
      "_id": "customer_id",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "subscriptionId": "subscription_id"
    }
  ],
  "pagination": {
    "totalCount": 150,
    "totalPages": 15,
    "currentPage": 1,
    "limit": 10,
    "hasNextPage": true,
    "hasPrevPage": false,
    "nextPage": 2,
    "prevPage": null,
    "nextUrl": "https://api.com/v1/customers?page=2&limit=10",
    "prevUrl": null
  },
  "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

default:1

Page number (default: 1)

Required range: x >= 1

limit

integer

default:10

Number of records per page (default: 10)

Required range: 1 <= x <= 100

string

Search by customer email

uniqueCustomerId

string

Search by unique customer ID

accountStatus

enum<string>

Filter by account status

Available options:

active,

inactive

onboardingCompleted

boolean

Filter by onboarding completion status

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)

Filter users who logged in X days ago

Required range: x >= 0

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

Successfully retrieved customers

data

object[]

Show child attributes

data._id

string

required

Customer ID

Example:

"customer_id"

data.firstName

string

required

Customer's first name

Example:

"John"

data.lastName

string

required

Customer's last name

Example:

"Doe"

data.email

string

required

Customer's email address

Example:

"[email protected]"

data.subscriptionId

string

required

Subscription ID

Example:

"subscription_id"

pagination

object

Show child attributes

pagination.totalCount

integer

required

Total number of customers matching the filters

Example:

150

pagination.totalPages

integer

required

Total number of pages

Example:

15

pagination.currentPage

integer

required

Current page number

Example:

1

pagination.limit

integer

required

Number of records per page

Example:

10

pagination.hasNextPage

boolean

required

Boolean indicating if there's a next page

Example:

true

pagination.hasPrevPage

boolean

required

Boolean indicating if there's a previous page

Example:

false

pagination.nextPage

integer | null

required

Next page number (null if no next page)

Example:

2

pagination.prevPage

integer | null

required

Previous page number (null if no previous page)

Example:

null

pagination.nextUrl

string | null

required

Complete URL for the next page

Example:

"https://api.com/v1/customers?page=2&limit=10"

pagination.prevUrl

string | null

required

Complete URL for the previous page

Example:

null

success

boolean

Example:

true

Introduction Get Customer

⌘I

Get Started

Reseller

Reseller - Customers

Reseller - Packages

Reseller - Invoices

Institution

Institution - Users

Resources

Get All Customers

Authorizations

Query Parameters

Response