Nexus · Powered by LaborEdge
Job Board API Reference
Authenticate, read master data, search jobs, and manage candidate records through the Nexus integration API. Every request requires a bearer token obtained from the authentication endpoint.
NOTE: APIs that have updates during the April 2026 production release are highlighted in yellow.
INPUT PARAMETERS (Form Data):
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| username | Yes | String | Registered API login username |
| password | Yes | String | Registered API login password |
| grant_type | Yes | String | Value must be "password" |
| client_id | Yes | String | Assigned Client Identity String |
| client_secret | Yes | String | Assigned Client Secret Key String |
OUTPUT:
{
"access_token": "86bb66d2-64bd-4e92-a178-e54456573bd2",
"token_type": "bearer",
"refresh_token": "a18856bd-4412-4211-78ab-a56d66e74112",
"expires_in": 43199,
"scope": "read write"
}
INPUT PARAMETERS (Form Data):
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| grant_type | Yes | String | Value must be "refresh_token" |
| refresh_token | Yes | String | The refresh token returned from the initial authentication call |
| client_id | Yes | String | Assigned Client Identity String |
| client_secret | Yes | String | Assigned Client Secret Key String |
OUTPUT:
{
"access_token": "92cc77e3-75ce-5fa3-b289-f65567684ce3",
"token_type": "bearer",
"refresh_token": "b29967ce-5523-5322-89bc-b67e77f85223",
"expires_in": 43199,
"scope": "read write"
}
OUTPUT:
[
{
"id": 15,
"name": "RN",
"code": "RN",
"active": true
},
{
"id": 16,
"name": "LPN",
"code": "LPN",
"active": true
}
]
OUTPUT:
[
{
"id": 24,
"name": "ER",
"code": "ER",
"active": true,
"professionId": 15
},
{
"id": 25,
"name": "ICU",
"code": "ICU",
"active": true,
"professionId": 15
}
]
GET
05Get States
OUTPUT:
[
{
"id": 256,
"name": "California",
"code": "CA",
"active": true,
"countryId": 6
},
{
"id": 242,
"name": "Texas",
"code": "TX",
"active": true,
"countryId": 6
}
]
OUTPUT:
[
{
"id": 6,
"name": "United States",
"code": "USA",
"active": true
},
{
"id": 8,
"name": "Canada",
"code": "CAN",
"active": true
}
]
OUTPUT:
[
{
"id": 1,
"name": "Prospect",
"code": "PROSPECT",
"active": true
},
{
"id": 2,
"name": "Active Available",
"code": "ACTIVE_AVAILABLE",
"active": true
}
]
OUTPUT:
[
{
"id": 2,
"name": "Website",
"code": "WEBSITE",
"active": true
},
{
"id": 5,
"name": "Employee Referral",
"code": "EMPLOYEE_REFERRAL",
"active": true
}
]
OUTPUT:
[
{
"id": 1475,
"name": "Simone Arora",
"email": "sarora@laboredge.com",
"active": true
}
]
OUTPUT:
[
{
"id": 1,
"name": "W2 Employee",
"code": "W2",
"active": true
},
{
"id": 2,
"name": "Independent Contractor",
"code": "IC",
"active": true
}
]
GET
11Get Jobs
INPUT: JSON Object
{
"jobStatusCode": "OPEN",
"startDateFrom": "2021-02-15",
"startDateTo": "2021-03-15",
"endDateFrom": "2021-06-02",
"endDateTo": "2021-06-30",
"professionIds": [269, 281],
"specialtyIds": [1640, 1664],
"stateIds": [4263, 4267],
"jobId": 8585,
"dateCreatedStart": "2022-08-25T16:55:29",
"dateCreatedEnd": "2022-08-30T22:15:05",
"dateModifiedStart": "2022-08-25T16:55:29",
"dateModifiedEnd": "2022-08-30T22:15:05",
"pagingDetails": {
"start": 0
},
"hotJob": true,
"postingId": "outpatient need",
"staffingSpecialistIds": [80, 3788],
"externalJobPostingId": "123456",
"city": ["Aberdeen", "Los Angeles"],
"zip": ["31701", "90011"]
}
Note: This API returns paginated records (100 at a time). Input field
pagingDetails is required. The 'start' value is the first record to be returned. The first record is record 0. Rest of the input fields are optional. From and To date ranges should be valid. With respect to the response, all the bill rates will be populated under rates array. Bill Rate Code that starts with BR_ is of type Bill Rate, where as, code that starts with PR_ is of type Pay Rate.
OUTPUT:
Note: "title" is generated by combining profession:specialty,shift start time-shift end time eg: "RN:ER,07:00:00-19:00:00". "jobTitle" will be populated from Nexus Job Details.
{
"count": 2,
"records": [
{
"id": 107203,
"jobTitle": null,
"postingId": null,
"displayOnExternalJobBoard": true,
"description": "Registered nurses fulfill a variety of job duties. In addition to the primary role in treating and caring for patients, their responsibilities also include educating patients and the public about a variety of medical conditions, as well as providing emotional support and advice to the families of their patients. Other RN job functions include performing diagnostic tests and analyzing results, administering medications, operating medical equipment, recording patients’ symptoms and medical histories, and assisting with patient rehabilitation and follow-up.",
"postedDate": "2023-08-10T12:24:49Z",
"preferredCertifications": "",
"signOnBonus": null,
"noOfOpenings": 1,
"jobType": "Travel",
"msa": false,
"startDate": "2023-08-10",
"endDate": "2023-11-04",
"asap": true,
"duration": 13,
"durationType": "WEEKS",
"jobStatusId": 43,
"jobStatus": "Open",
"jobStatusCode": "OPEN",
"jobHotJob": true,
"floatingReqUnits": "Float to areas of Competency. 123",
"positionType": null,
"shiftStartTime1": "08:00:00",
"shiftEndTime1": "16:00:00",
"shiftStartTime2": null,
"shiftEndTime2": null,
"shiftsPerWeek1": 5,
"scheduledHrs1": 40.0,
"shiftsPerWeek2": null,
"scheduledHrs2": null,
"shift": "8 AM - 4 PM ( This is a regular 8 hour shift. ) ",
"title": "RN:ER,08:00:00-16:00:00",
"offering": "Nursing",
"subOffering": null,
"professionId": 15,
"specialtyId": 24,
"profession": "RN",
"specialty": "ER",
"salesRepId": 3926,
"saleRepFirstName": "test",
"saleRepLastName": "Patil",
"saleRepEmail": "dpatil@yopmail.com",
"staffingSpecialistId": 80,
"staffingSpecialistFirstName": "Tina",
"staffingSpecialistLastName": "Mihic",
"staffingSpecialistEmail": "tMihic@laboredge.com",
"vmsId": 486,
"vms": "Ketan Test1",
"clientName": "Freedom",
"clientWebsite": null,
"clientPrimaryDivision": "Div AO",
"clientCity": "Allenton",
"clientStateId": 245,
"clientState": "Wisconsin",
"clientStateCode": "WI",
"clientZip": "53002",
"clientCountry": "USA",
"requiredCertificationsForOnboarding": [
"ACLS",
"APN - Advance Nurse Practitioner - Adult",
"Acute Rehabilitation Nurse",
"Audiology tech",
"BLS",
"Bank Security Training (Sertifi)",
"CT Tech",
"CVOR",
"California Certification",
"Cath Lab RN 5555",
"Client NOC ( Sertifi )",
"Core 1",
"Core 2 (Nursing)",
"Core 3 ",
"Core Mandatory Exam",
"Core Mandatory Part II (Nursing)",
"Core Mandatory Part III",
"Corrections",
"Critical Care",
"ER",
"ER Checklist",
"Employee_Stat",
"First Assist",
"Flu Vaccination",
"General Progressive Care Unit",
"HIPAA Basics",
"HIPAA/Data Privacy Act",
"HSH Checklist - Nursery and Mother Baby",
"HSH Color Vision Exam",
"HSH ER Checklist",
"HSH FADV",
"HSH School Nurse",
"HSH Stark Law",
"HSH T0318.1",
"HSH T0318.2",
"HSH T0318.3",
"HSH T0321.1",
"HSH Testing",
"HSH Testing 3",
"HSH Workplace Violence",
"IV Push Medications",
"IV Therapy",
"Ishihara Compliant Color Vision Exam",
"Joint Commission Cert-er",
"L & D",
"Labor And Delivery RN",
"License Certificate - TX",
"NICU",
"NRP",
"NamCon",
"Nurse Manager/Supervisor",
"OR Cardio",
"OSHA Training",
"Oncology",
"PALS",
"Pediatric",
"Pediatric OR",
"Prophecy Cand Cert Test 1",
"Prophecy Cand Cert Test 2",
"Prophecy Cand Cert Test 4",
"Prophecy Cand Cert Test 5",
"Psych",
"RN - Emergency Room (ER)",
"RN - Emergency Room - Adult/General",
"RN - Medication/Pharmacology - General",
"RN ER Job Description",
"Random Drug Tests",
"Surg Tech",
"TNCC",
"Tele",
"Test Relias",
"Test cert 3",
"Test-skill",
"Texas DPS_Insurance",
"Workplace Violence",
"commitdateTEst",
"nex test - 3",
"nex test - 4",
"nex test-1",
"nex test-2",
"nex test-5",
"test KP",
"test Ketan"
],
"requiredCertificationsForSubmittal": [
"AWHONN",
"CBIS"
],
"rates": [
{
"billRateCodeId": "BR_REGULAR_BILL_RATE",
"billRateCode": "Regular Bill Rate",
"rate": 88.0
},
{
"billRateCodeId": "BR_GREATER_THAN_EIGHT",
"billRateCode": ">8 Bill Rate",
"rate": 132.0
},
{
"billRateCodeId": "BR_GREATER_THAN_FOURTY",
"billRateCode": ">40 Bill Rate",
"rate": 132.0
},
{
"billRateCodeId": "BR_HOLIDAY_RATE",
"billRateCode": "Holiday Bill Rate",
"rate": 132.0
}
],
"week1Gross": "$1695.37",
"nexusClientId": 3460,
"availableOpenings": null,
"postedBy": "Ketan Potale",
"vmsFee": 12.0,
"length": 13,
"additionalInformation": "",
"department": null,
"departmentId": null,
"offeringId": "NURSING",
"subOfferingId": null,
"workersCompCode": null,
"lodgingAmount": 685.99,
"mealAmount": 369.3800000000001,
"hourlyStipendRate": 26.38,
"featuredJob": true,
"positionUrgencyId": "NORMAL",
"positionUrgency": "Normal",
"nonBillableHrs": 21.0,
"billableHrs": 17.0,
"billablePercent": 45.0,
"weeklyPay": 1695.37,
"hourlyPay": 42.38,
"hourlyPayRange": "$32.38 - $42.38",
"weeklyPayRange": "$1670.37 - $1695.37",
"jobFillReason": "Filled by Nexus,Filled by Nexus,Filled by Nexus",
"jobSetting": "Long Term Care",
"lastModifiedDateTime": "2024-11-14T18:28:31",
"jobReopened": false,
"jobReopenedDate": null,
"callRequired": true,
"callRequiredDetails": "1 shift a month"
},
{
"id": 107214,
"jobTitle": null,
"postingId": null,
"displayOnExternalJobBoard": true,
"description": "Registered nurses fulfill a variety of job duties. In addition to the primary role in treating and caring for patients, their responsibilities also include educating patients and the public about a variety of medical conditions, as well as providing emotional support and advice to the families of their patients. Other RN job functions include performing diagnostic tests and analyzing results, administering medications, operating medical equipment, recording patients’ symptoms and medical histories, and assisting with patient rehabilitation and follow-up.",
"postedDate": "2023-08-10T14:14:36Z",
"preferredCertifications": "",
"signOnBonus": null,
"noOfOpenings": 1,
"jobType": "Travel",
"msa": false,
"startDate": "2023-08-10",
"endDate": "2023-11-04",
"asap": true,
"duration": 13,
"durationType": "WEEKS",
"jobStatusId": 43,
"jobStatus": "Open",
"jobStatusCode": "OPEN",
"jobHotJob": true,
"floatingReqUnits": "Float to areas of Competency. 123",
"positionType": null,
"shiftStartTime1": "08:00:00",
"shiftEndTime1": "16:00:00",
"shiftStartTime2": null,
"shiftEndTime2": null,
"shiftsPerWeek1": 5,
"scheduledHrs1": 40.0,
"shiftsPerWeek2": null,
"scheduledHrs2": null,
"shift": "8 AM - 4 PM ( This is a regular 8 hour shift. ) ",
"title": "RN:ICU,08:00:00-16:00:00",
"offering": "Nursing",
"subOffering": null,
"professionId": 15,
"specialtyId": 25,
"profession": "RN",
"specialty": "ICU",
"salesRepId": 3926,
"saleRepFirstName": "test",
"saleRepLastName": "Patil",
"saleRepEmail": "dpatil@yopmail.com",
"staffingSpecialistId": 80,
"staffingSpecialistFirstName": "Tina",
"staffingSpecialistLastName": "Mihic",
"staffingSpecialistEmail": "tMihic@laboredge.com",
"vmsId": 486,
"vms": "Ketan Test1",
"clientName": "Freedom",
"clientWebsite": null,
"clientPrimaryDivision": "Div AO",
"clientCity": "Allenton",
"clientStateId": 245,
"clientState": "Wisconsin",
"clientStateCode": "WI",
"clientZip": "53002",
"clientCountry": "USA",
"requiredCertificationsForOnboarding": [
"APN - Advance Nurse Practitioner - Adult",
"Audiology tech",
"BLS",
"Bank Security Training (Sertifi)",
"Client NOC ( Sertifi )",
"Core 1",
"Core 2 (Nursing)",
"Core 3 ",
"Core Mandatory Exam",
"Critical Care Checklist",
"First Assist",
"HIPAA/Data Privacy Act",
"HSH Checklist - Nursery and Mother Baby",
"HSH ICU Exam",
"HSH Testing",
"HSH Testing 3",
"ICU CHECKLIST",
"ICU Exam",
"Ishihara Compliant Color Vision Exam",
"Junxion Specialty Remove",
"NRP",
"NamCon",
"OSHA Training",
"RN - Intensive Care Unit (ICU) Nurse",
"Test Relias",
"Test cert 3",
"Test-skill",
"nex test - 3",
"nex test - 4",
"nex test-1",
"nex test-2",
"nex test-5",
"test KP"
],
"requiredCertificationsForSubmittal": [],
"rates": [
{
"billRateCodeId": "BR_REGULAR_BILL_RATE",
"billRateCode": "Regular Bill Rate",
"rate": 85.0
},
{
"billRateCodeId": "PR_REGULAR_PAY_RATE",
"billRateCode": "Regular Pay Rate",
"rate": 70.0
},
{
"billRateCodeId": "BR_GREATER_THAN_EIGHT",
"billRateCode": ">8 Bill Rate",
"rate": null
},
{
"billRateCodeId": "BR_GREATER_THAN_FOURTY",
"billRateCode": ">40 Bill Rate",
"rate": 90.0
},
{
"billRateCodeId": "PR_GREATER_THAN_FOURTY",
"billRateCode": ">40 Pay Rate",
"rate": 80.0
},
{
"billRateCodeId": "BR_CALL_BACK_RATE",
"billRateCode": "Call Back Bill Rate",
"rate": null
},
{
"billRateCodeId": "BR_ON_CALL_RATE",
"billRateCode": "On-Call Bill Rate",
"rate": null
},
{
"billRateCodeId": "BR_HOLIDAY_RATE",
"billRateCode": "Holiday Bill Rate",
"rate": null
}
],
"week1Gross": "$2835.37",
"nexusClientId": 3460,
"availableOpenings": null,
"postedBy": "Ketan Potale",
"vmsFee": 12.0,
"length": 13,
"additionalInformation": "",
"department": null,
"departmentId": null,
"offeringId": "NURSING",
"subOfferingId": null,
"workersCompCode": null,
"lodgingAmount": 22.99,
"mealAmount": 12.38,
"hourlyStipendRate": 0.88,
"featuredJob": true,
"positionUrgencyId": "NORMAL",
"positionUrgency": "Normal",
"nonBillableHrs": 21.0,
"billableHrs": 17.0,
"billablePercent": 45.0,
"weeklyPay": 2835.37,
"hourlyPay": 70.88,
"hourlyPayRange": "$60.88 - $70.88",
"weeklyPayRange": "$2810.37 - $2835.37",
"jobFillReason": "Filled by Nexus,Filled by Nexus,Filled by Nexus",
"jobSetting": "Hospital",
"lastModifiedDateTime": "2025-07-22T21:38:49",
"jobReopened": false,
"jobReopenedDate": null,
"callRequired": true,
"callRequiredDetails": "1 shift a month"
}
]
}
INPUT: JSON Object
{
"firstName": "Morris",
"lastName": "Jhonnasan",
"primaryEmail": "Moris@yopmail.com",
"phone": "123-455-7890",
"cellPhone": "987-464-3210",
"statusId": 1,
"referralSourceId": 2,
"professionIds": [15],
"specialtyIds": [24],
"primarySpecialtyId": 24,
"jobTypeIds": [
"PERM",
"TRAVEL",
"PERDIEM",
"LOCAL"
],
"addressLine1": "123 Main St",
"addressLine2": "Apt 456",
"stateId": null,
"city": "Springfield",
"zip": "12345",
"countryId": 8,
"yearsOfExperience": 5.5,
"availableFrom": "2023-09-01",
"preferredStateIds": [228],
"candidateTypeIds": [1],
"licensedStateIds": [241, 259],
"travelStatus": true,
"candidatePrimaryDivisionId": null,
"candidateSecondaryDivisionIds": null,
"sendMassEmails": false,
"sendMassSms": true,
"recruiterId": 1475,
"ambassadorUrl": "https://434.ambassador",
"ambassador": true,
"facebook": "facebook.lofitest.com",
"instagram": "instagram.lofitest.com",
"linkedin": "linkedin.lofitest.com",
"other": "others.com",
"staffingSpecialistId": 39576,
"candidatePRNStatusId": 59,
"preferredShiftIds": [411, 540, 594],
"isHotCandidate": false,
"dob": "1979-10-11",
"npi": 123456789,
"leap": true,
"jobId": 248442,
"middleName": "M",
"candidateHighlights": "3 Years ",
"availabilityLogNotes": "Flexible on state",
"desiredMinWeeklyGrossPay": 1234,
"desiredMaxWeeklyGrossPay": 12345,
"desiredArea": "Test1"
}
INPUT NOTES:
- Required Fields – firstName, lastName, statusId, referralSourceId, professionIds, specialtyIds, primarySpecialtyId, stateId, countryId, jobTypeIds.
- jobTypeIds - can have values "LOCAL", "PERDIEM", "PERM", "TRAVEL".
- specialtyIds and primarySpecialtyId if any should belong to one of the professionIds in the request.
- licensedStateIds – inserts into candidate professional license any missing combination of licensedStateIds and professionIds. No inserts if licensedStateIds are empty or null.
- statusId – will not be updated if null
- phone – this field is mapped to home phone in nexus
- In Nexus candidate details, Cell Phone is marked as primary phone if its not null else it is defaulted to Home Phone.
- User includes jobTypes as PERDIEM in a request, the PRN status ID must be mandatory in request, otherwise error message will display.
OUTPUT:
{
"id": 5841569
}
Note:
{candidateId} is to be replaced with the id of the candidate in the system.
INPUT: JSON Object
{
"firstName": "JohnQ",
"lastName": "DoeQ",
"primaryEmail": "johndoQe@example.com",
"phone": "123-455-7890",
"cellPhone": "987-464-3210",
"statusId": 1,
"referralSourceId": 2,
"professionIds": [15],
"specialtyIds": [24],
"primarySpecialtyId": 24,
"jobTypeIds": [
"PERM",
"TRAVEL",
"PERDIEM",
"LOCAL"
],
"addressLine1": "123 Main St",
"addressLine2": "Apt 456",
"stateId": null,
"city": "Springfield",
"zip": "12345",
"countryId": 8,
"yearsOfExperience": 5.5,
"availableFrom": "2023-09-01",
"preferredStateIds": [228],
"candidateTypeIds": [1],
"licensedStateIds": [241, 259],
"travelStatus": true,
"candidatePrimaryDivisionId": null,
"candidateSecondaryDivisionIds": null,
"sendMassEmails": false,
"sendMassSms": true,
"recruiterId": 1475,
"ambassadorUrl": "https://1234.ambassador",
"ambassador": true,
"facebook": "facebook.lofitest.com",
"instagram": "instagram.lofitest.com",
"linkedin": "linkedin.lofitest.com",
"other": "others.com",
"staffingSpecialistId": 39576,
"preferredShiftIds": [411, 540, 594],
"dob": "1979-10-11",
"npi": 123456789,
"middleName": "M",
"candidateHighlights": "3 Years ",
"availabilityLogNotes": "Flexible on state",
"desiredMinWeeklyGrossPay": 159,
"desiredMaxWeeklyGrossPay": 956,
"secondaryEmail": "Lee.Test@yopmail.com",
"workPhone": "123-455-7890",
"desiredArea": "Test1"
}
INPUT NOTES:
- Required Fields – firstName, lastName, statusId, referralSourceId, professionIds, specialtyIds, primarySpecialtyId, stateId, countryId, jobTypeIds.
- jobTypeIds - can have values "LOCAL", "PERDIEM", "PERM", "TRAVEL".
- specialtyIds and primarySpecialtyId if any should belong to one of the professionIds in the request.
- licensedStateIds – inserts into candidate professional license any missing combination of licensedStateIds and professionIds. No inserts if licensedStateIds are empty or null.
- statusId – will not be updated if null
- phone – this field is mapped to home phone in nexus
- In Nexus candidate details, Cell Phone is marked as primary phone if its not null else it is defaulted to Home Phone.
OUTPUT:
{
"id": 5841538
}
POST
14Get Candidates
INPUT: JSON Object
{
"dateCreatedStart": "2021-03-02T16:55:29",
"dateCreatedEnd": "2021-03-05T22:15:05",
"dateModifiedStart": "2021-03-02T16:55:32",
"dateModifiedEnd": "2021-03-03T22:27:58",
"email": "tmihic1@gmail.com",
"phone": "(214) 376-7452",
"statusId": 55,
"pagingSortingDetails": {
"start": 0,
"maxRowsToFetch": 100
},
"npi": "9786987698"
}
Note: This API will return 100 records at a time. If there are more than 100 records, place another API call with
start: 100. You can navigate through the records based on the count returned from the response. All the date fields are optional, if none of the dates are provided, all the records will be fetched. Phone field should be in format (XXX) XXX-XXXX. If phone number is passed in search request then the api will return the candidates having exact match of either cell phone or leap phone or home phone or work phone.
OUTPUT:
{
"count": 708,
"records": [
{
"candidateId": 112,
"firstName": "Elliott",
"lastName": "Copley",
"email": "tmihic1@gmail.com",
"phone": "(210) 899-4677",
"cellPhone": "(210) 899-4677",
"statusId": null,
"referralSourceId": 5,
"professionIds": [15],
"specialtyIds": [24, 25],
"primarySpecialtyId": 24,
"addressLine1": " 4585 Ferry Drive ",
"addressLine2": null,
"stateId": 256,
"city": "Los Angeles",
"zip": "90003",
"countryId": 6,
"statusCode": "PROSPECT",
"status": "Prospect",
"stateCode": "CA",
"state": "California",
"countryCode": "USA",
"country": "United States",
"employeeType": null,
"referralSourceName": "Website",
"organizationCode": "Nexus",
"organization": "Nexus",
"candidatePrimaryDivisionId": null,
"candidatePrimaryDivision": null,
"jobTypeIds": ["LOCAL", "PERDIEM", "PERM", "TRAVEL"],
"gender": null,
"race": null,
"veteranStatus": null,
"hireDate": null,
"terminationDate": null,
"rehireDate": null,
"payrollId": "64993",
"middleName": "",
"preferredName": null,
"refferralBy": "Nancy Yu",
"secondaryDivision": ["Southeast", "East", "North"],
"degreeType": ["BSN-Bachelor of Science in Nursing"],
"recruiter": "Simone Arora",
"staffingSpecialistId": 80,
"staffingSpecialist": "Tina Mihic",
"complianceManagerId": 18,
"complianceManager": "Josh Tabit",
"workPhone": null,
"leapPhone": null,
"homePhone": null,
"contactPreference": null,
"sendMassEmails": true,
"sendMassSms": true,
"primaryEmail": "tmihic1@gmail.com",
"secondaryEmail": null,
"leapEmail": null,
"region": null,
"temporaryAddressLine1": null,
"temporaryAddressLine2": null,
"temporaryCountry": null,
"temporaryCountryId": null,
"temporaryRegion": null,
"temporaryState": null,
"temporaryStateId": null,
"temporarySearchCity": null,
"temporarySearchZip": null,
"emergencyName": null,
"emergencyRelationship": null,
"emergencyPhone": null,
"emergencyEmail": null,
"emergencyAddressLine1": null,
"emergencyAddressLine2": null,
"emergencyState": null,
"emergencyStateId": null,
"emergencySearchCity": null,
"emergencySearchZip": null,
"prnStatusId": 52,
"prnStatusName": "Pending",
"prnStatusCode": "PENDING",
"createdDate": "2019-02-05T09:40:38",
"benefitList": [
"Benefits Declined",
"BCBS Individual PPO"
],
"hotCandidate": true,
"lastModifiedDateTime": "2025-04-03T09:29:44",
"originalRecruiterName": null,
"candidateHighlights": null,
"availabilityLogNotes": null,
"desiredMinWeeklyGrossPay": 159,
"desiredMaxWeeklyGrossPay": 956,
"npi": "5657565756",
"jaCount": -1,
"recruiterEmail": "jitendra.shingate@mewhiz.com",
"leapPercentage": 80
}
]
}
Note:
{candidateId} is to be replaced with the id of the candidate in the system.
OUTPUT:
{
"candidateId": 1903544,
"firstName": "Georgia",
"lastName": "Lynne",
"email": "georgia.lynne@yopmail.com",
"phone": "1234413432",
"cellPhone": "",
"statusId": 12,
"referralSourceId": "55",
"candidatePrimaryDivisionId": 57,
"candidatePrimaryDivision": "East",
"secondaryDivision": ["East"],
"candidateSecondaryDivisionIds": [57],
"professionIds": [12, 23],
"specialtyIds": [43, 45, 56, 67],
"primarySpecialtyId": 45,
"jobTypeIds": [
"LOCAL",
"PERDIEM",
"PERM",
"TRAVEL"
],
"addressLine1": "1304 Burlington Dr",
"addressLine2": "",
"stateId": "34",
"city": "Odenton",
"zip": "21113",
"countryId": "10",
"preferredStateIds": [249, 229, 255, 252],
"candidateTypeIds": [1, 5, 9, 10, 6, 2],
"licensedStateIds": [220, 228, 237, 241],
"travelStatus": true,
"recruiterId": 1,
"sendMassEmails": false,
"sendMassSms": false,
"ambassadorUrl": "https://434.ambassador",
"ambassador": true,
"prnStatusId": 52,
"prnStatusName": "Pending",
"prnStatusCode": "PENDING",
"staffingSpecialistId": 11,
"staffingSpecialist": "Json jakes",
"createdDate": "2019-02-05T09:40:38",
"benefitList": [
"Benefits Declined",
"BCBS Individual PPO"
],
"hotCandidate": false,
"lastModifiedDateTime": "2025-01-21T07:05:25",
"originalRecruiterName": null,
"candidateHighlights": null,
"availabilityLogNotes": null,
"desiredMinWeeklyGrossPay": 159,
"desiredMaxWeeklyGrossPay": 956,
"npi": "5657565756",
"jaCount": -1,
"recruiterEmail": "jitendra.shingate@mewhiz.com",
"leapPercentage": 80
}
OUTPUT:
[
{
"id": null,
"name": "Abhijeet Tekale ",
"email": "abhijeet.tekale@mewhiz.com ",
"active": true
}
]
GET
17Get Shifts
OUTPUT:
[
{
"id": 413,
"name": "10:30A-10:20P",
"active": false,
"typeId": "2",
"type": "mids"
}
]
INPUT: JSON Object
{
"firstName": "Test Patch1",
"lastName": "Test Patch",
"primaryEmail": "testpatch@yopmail.com",
"phone": "(476) 123-9458",
"cellPhone": "(456) 129-9458",
"statusId": null,
"referralSourceId": null,
"professionIds": null,
"specialtyIds": null,
"primarySpecialtyId": null,
"jobTypeIds": null,
"addressLine1": "Patchtest1",
"addressLine2": "patchtest2",
"stateId": null,
"city": null,
"zip": null,
"countryId": null,
"yearsOfExperience": null,
"availableFrom": null,
"preferredStateIds": null,
"isHotCandidate": false,
"dob": "1979-10-11",
"npi": 123456789,
"middleName": "M",
"candidateHighlights": "3 Years ",
"availabilityLogNotes": "Flexible on state",
"desiredMinWeeklyGrossPay": 159,
"desiredMaxWeeklyGrossPay": 956,
"secondaryEmail": "Lee.Test@yopmail.com",
"workPhone": "123-455-7890",
"desiredArea": "Test1"
}
OUTPUT:
{
"id": 5942402
}
INPUT: JSON Object
If international is false
{
"international": false,
"schoolName": "ABC School",
"fieldOfStudy": "Nursing",
"degreeTypeId": 2,
"countryId": 6,
"city": "Texas City",
"stateId": 242,
"startDateOfDegree": "2013-01-18",
"graduationDate": "2020-02-18",
"nameAtGraduation": "Job Type 5",
"nameOnDegree": "Jobtype5"
}
If international is true
{
"international": true,
"schoolName": "One New Education",
"country": "United States",
"degreeType": "Bachelor of Arts new",
"startDateOfDegree": "2019-10-20",
"graduationDate": "2023-07-15",
"state": "Greater London 2",
"city": "London 2",
"nameOnDegree": "job Type6",
"fieldOfStudy": "Nursing 1",
"nameAtGraduation": "jobtype 6"
}
OUTPUT:
{
"id": 20315
}
NOTES:
Mandatory Fields:
- If international is false then mandatory fields are schoolName, countryId, degreeTypeId, startDateOfDegree, graduationDate.
- If international is true then mandatory fields are schoolName, country, degreeType, startDateOfDegree, graduationDate. And country, degreeType, state values should be text fields.
If the city provided in the API request is not valid for the specified state ID, the city should not appear in the UI selection.
INPUT: JSON Object
{
"hospitalName": "California City Hospital - SouthBlock1",
"employedFromDate": "1994-06-15",
"employedToDate": "2024-09-15",
"countryId": 6,
"stateId": 256,
"professionId": 15,
"specialtyIds": [24],
"formerClientName": "California Hospital",
"cityName": "Agoura Hills",
"positionTypeId": 4,
"agencyName": "Indian Medical Staffing",
"agencyPhoneNo": "(986) 083-1051",
"chargeNurse": true,
"perceptor": true,
"floatedUnits": [25],
"hospitalSize": 50,
"hoursOfOnTheJobTraining": "1",
"unitSize": 50,
"patientRatio": "1",
"patientRatio1": "3",
"traumaLevel": "LEVEL1",
"pediatricLevel": "LEVEL1",
"nicuLevel": "LEVEL1",
"empHistoryChartingIds": [],
"equipmentInstrumentIds": [],
"managerFirstName": "Jitendra",
"managerLastName": "Shingate",
"managerPhone": "(986) 083-2238",
"reasonForLeaving": "Unknown",
"contactAsReference": true,
"teachingHospital": true,
"magnetDesignated": true,
"responsibilities": "Test"
}
OUTPUT:
{
"id": 73972
}
NOTES:
Mandatory Fields: hospitalName, employedFromDate, countryId, stateId, professionId, specialtyIds
INPUT: JSON Object
{
"hospitalName": "PROFESSIONAL Test 2",
"formerClientName": "Professional Test",
"employedFromDate": "1977-01-15",
"employedToDate": "1978-02-15",
"international": false,
"countryId": 6,
"stateId": 256,
"cityName": "Acampo",
"managerFirstName": "Test Manager First Name",
"managerLastName": "Test Manager Last Name",
"managerPhone": "(986) 083-2238",
"reasonForLeaving": "Test Reason for Leaving",
"contactAsReference": true,
"responsibilities": "Test Responsibilities"
}
OUTPUT:
{
"id": 74108
}
NOTES:
Mandatory Fields: hospitalName, employedFromDate, countryId, stateId
INPUT: JSON Object
{
"employedFromDate": "1977-01-15",
"employedToDate": "1978-02-15",
"international": false,
"countryId": 6,
"stateId": 256,
"cityName": "Acampo",
"gapReasonId": 5,
"gapReasonExplanation": "Test Gap Reason Explanation"
}
OUTPUT:
{
"id": 74108
}
NOTES:
Mandatory Fields: employedFromDate, countryId, stateId, gapReasonId
POST
23Refer a Friend
INPUT: JSON Object
{
"referredFirstName": "Rahul",
"referredLastName": "Mane",
"professionIds": [18],
"specialtyIds": [35],
"notifyFriend": false,
"referredByFirstName": "Devendra",
"referredByLastName": "L",
"referralSourceId": "397"
}
OUTPUT:
{
"id": 74108
}
OUTPUT:
[
{
"id": 252,
"name": "Backfill__BSBSBSBSBSBSBSSBSBSBSSSVSVSVSV",
"code": "backfill_QWEQWE",
"active": true,
"supportedJobTypes": [
"PERM",
"LOCAL",
"TRAVEL"
]
},
{
"id": 2753,
"name": "Backfill__BULWARKERS_BUSD",
"code": "backfill",
"active": true,
"supportedJobTypes": [
"PERM",
"TRAVEL",
"LOCAL"
]
}
]