LocumJobsOnline API v2.0
Lead Data
The leads endpoint is used to fetch application data submitted by leads on LocumJobsOnline.
Fetch leads
GET https://www.locumjobsonline.com/api/v2.0/leads.jsonxml
Parameters
Parameters should be appended to the endpoint URL as a standard query string.
Name | Format/Values | Required | Description |
---|---|---|---|
No | Fetch only leads with the specified email address. | ||
employment_type |
One of the following values:
|
No | Fetch only leads with the specified employment type. |
end_date | YYYY-MM-DD or YYYY-MM-DDThh:mm:ss | No | Fetch only leads who submitted their application to your company or were unlocked before the specified date or date/time. |
end_unlocked_date | YYYY-MM-DD or YYYY-MM-DDThh:mm:ss | No | Fetch only leads who were unlocked by your employer on or before the specified date or date/time. |
first_name | String | No | Fetch only leads with the specified first name. |
has_job_apps |
One of the following values:
|
No | Fetch only leads who have (1 ) or have not (0 ) applied to one of your jobs. |
job_title | String | No | Fetch only leads who applied to a job of the specified title. |
last_name | String | No | Fetch only leads with the specified last name. |
license |
One of the following values:
|
No | Fetch only leads with the specified license. |
licensed_states | USPS 2-letter state abbreviation, or Compact |
No | Fetch only leads who are licensed in the specified state(s). |
lives_within_radius | Integer > 0 | No | Fetch only leads who live within the specified radius (in miles) of the location provided in lives_within_zip . |
lives_within_zip | ZIP code | No | Fetch only leads who live within the radius (in miles) provided in lives_within_radius of the specified location. |
max | Integer > 0 | No | Maximum number of leads to return. |
min_experience |
One of the following values:
|
No | Fetch only leads with at least the specified minimum experience. |
not_unlocked |
One of the following values:
|
No | Fetch only leads who have not been unlocked by your employer. |
phone | Phone | No | Fetch only leads with the specified phone number. |
sort |
One of the following values:
|
No | Sort by the specified field. Defaults to ascending order; for descending order, put a For example: |
start_date | YYYY-MM-DD or YYYY-MM-DDThh:mm:ss | No | Fetch only leads who submitted their application to your company or were unlocked after the specified date or date/time. |
start_unlocked_date | YYYY-MM-DD or YYYY-MM-DDThh:mm:ss | No | Fetch only leads who were unlocked by your employer on or after the specified date or date/time. |
state | USPS 2-letter state abbreviation | No | Fetch only leads who reside in the specified state. |
travel_status |
One of the following values:
|
No | Fetch only leads of the specified travel status. |
unlocked_by | No | Fetch only leads who were unlocked by the specified user. | |
work_eligible |
One of the following values:
|
No | Fetch only leads of the specified work eligibility. |
Sample Request
To show only 2 company leads in Kentucky, sorted alphabetically by name, your request
would look like this:
GET https://www.locumjobsonline.com/api/v2.0/leads.jsonxml?state=KY&license=CRNA&sort=name&max=2
Sample Response
[
{
"id": "12345",
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"phone": "1234567890",
"license": "CRNA",
"city": "Louisville",
"state": "KY",
"zip": "40210",
"sent": "2015-12-08T15:24:35-05:00",
"has_job_apps": true
},
{
"id": "67890",
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]",
"phone": "1234657890",
"license": "DO",
"city": "Lexington",
"state": "KY",
"zip": "40503",
"sent": "2015-12-08T15:24:35-05:00",
"has_job_apps": false
}
]
<?xml version="1.0"?>
<leads>
<lead>
<id>12345</id>
<first_name>John</first_name>
<last_name>Doe</last_name>
<email>[email protected]</email>
<phone>1234567890</phone>
<license>CRNA</license>
<city>Louisville</city>
<state>KY</state>
<zip>40210</zip>
<sent>2015-12-08T15:24:35-05:00</sent>
<has_job_apps>1</has_job_apps>
</lead>
<lead>
<id>67890</id>
<first_name>Jane</first_name>
<last_name>Smith</last_name>
<email>[email protected]</email>
<phone>1234657890</phone>
<license>DO</license>
<city>Lexington</city>
<state>KY</state>
<zip>40503</zip>
<sent>2015-12-08T15:24:35-05:00</sent>
<has_job_apps></has_job_apps>
</lead>
</leads>
Fetch a Single Lead
GET https://www.locumjobsonline.com/api/v2.0/leads.jsonxml/{id}
Parameters
Parameters should be appended to the endpoint URL.
Field | Format/Values | Required | Description |
---|---|---|---|
id | Integer | Yes | The ID number of the lead you want to fetch. |
Sample Request
GET https://www.locumjobsonline.com/api/v2.0/leads.jsonxml/12345
Sample Response
{
"first_name": "John",
"last_name": "Doe",
"address": "1234 Example Street",
"address2": null,
"city": "Louisville",
"state": "KY",
"zip": "40210",
"sent": "2015-12-08T15:24:35-05:00",
"email": "[email protected]",
"phone": "1234567890",
"license": "DO",
"experience": "21 - 25",
"employmentType": "Part-Time",
"specialties": "Otolaryngology",
"contact_time": "Weekends",
"work_eligible": "Yes",
"licensed_states": "New York",
"preferred_destinations": "Maryland",
"license_number": "f2a0i1n0k9e1l2d3e5g5",
"license_state": "New Jersey",
"license_date_issued": "09/15/1931",
"license_date_expires": "12/30/1959",
"license_investigated": "No",
"license_investigation_details": "",
"travel_status": "None",
"employment_history": [
{
"company": "Example Company",
"state": "PA",
"phone": "1234567890",
"start_date": "2021-01-1",
"end_date": null
}
],
"job_applications": [
{
"job_id": 98461,
"title": "Example Job Title",
"reference": "EXAMPLE12356",
"created_at": "1967-07-01T15:10:18+00:00"
}
],
"unlocked_by": "Smith, John"
}
<?xml version="1.0"?>
<leads>
<lead>
<first_name>John</first_name>
<last_name>Doe</last_name>
<address>1234 Example Street</address>
<address2></address2>
<city>Louisville</city>
<state>KY</state>
<zip>40210</zip>
<sent>2015-12-08T15:24:35-05:00</sent>
<email>[email protected]</email>
<phone>1234567890</phone>
<license>DO</license>
<experience>21 - 25</experience>
<employmentType>Part-Time</employmentType>
<specialties>Otolaryngology</specialties>
<contact_time>Weekends</contact_time>
<work_eligible>Yes</work_eligible>
<licensed_states>New York</licensed_states>
<preferred_destinations>Maryland</preferred_destinations>
<license_number>f2a0i1n0k9e1l2d3e5g5</license_number>
<license_state>New Jersey</license_state>
<license_date_issued>09/15/1931</license_date_issued>
<license_date_expires>12/30/1959</license_date_expires>
<license_investigated>No</license_investigated>
<license_investigation_details></license_investigation_details>
<travel_status>None</travel_status>
<employment_history>
<company>Example Company</company>
<state>PA</state>
<phone>1234567890</phone>
<start_date>2021-01-1</start_date>
<end_date></end_date>
</employment_history>
<job_applications>
<job_id>98461</job_id>
<title>Example Job Title</title>
<reference>EXAMPLE12356</reference>
<created_at>1967-07-01T15:10:18+00:00</created_at>
</job_applications>
<unlocked_by>Smith, John</unlocked_by>
</lead>
</leads>