AlliedTravelCareers API v2.0
Leads
The leads resource is used to manage application data submitted by leads on AlliedTravelCareers.
List all leads
URL Parameters
No parameters.
Query Parameters
optional
email
Fetch only leads with the specified email address.
optional
date-time
Fetch only leads who submitted their application to your company or were unlocked before the specified date or date/time.
optional
date-time
Fetch only leads who were unlocked by your agency on or before the specified date or date/time.
optional
string
Fetch only leads with the specified first name.
optional
boolean
Fetch only leads who have (1
) or have not (0
) applied to one of your jobs.
optional
string
Fetch only leads who applied to a job of the specified title.
optional
string
Fetch only leads with the specified last name.
optional
enum
Fetch only leads with the specified license.
Possible enum values:PT
PTA
OT
COTA
SLP
Dialysis Tech
Echo Tech
Histo Tech
Medical Lab Technician
Medical Technologist
Pharmacist
Rad Tech
Resp Tech
RRT
Surg Tech
Ultrasound
Vascular Tech
CT Tech
Nuclear Medicine Tech
Cath Lab Tech
Mammography Tech
MRI Tech
Special Procedures Tech
X-Ray Tech
Radiation Therapist
Dosimetrist
Electrophysiology Tech
Recreational Therapist
Phlebotomist
Pharmacy Tech
Licensed Clinical Social Worker
Psychology
Sterile Processing Tech
Interventional Radiology
Medical Assistant
Technician
EMT
Anesthesia Technician
optional
enum
Fetch only leads who are licensed in the specified state(s).
Possible enum values:AL
AK
AZ
AR
CA
CO
CT
DE
FL
GA
HI
ID
IL
IN
IA
KS
KY
LA
ME
MD
MA
MI
MN
MS
MO
MT
NE
NV
NH
NJ
NM
NY
NC
ND
OH
OK
OR
PA
RI
SC
SD
TN
TX
UT
VT
VA
WA
DC
WV
WI
WY
Compact
optional
integer
Fetch only leads who live within the specified radius (in miles) of the location provided in lives_within_zip
.
optional
string
Fetch only leads who live within the radius (in miles) provided in lives_within_radius
of the specified location.
optional
integer
Maximum number of leads to return.
optional
enum
Fetch only leads with at least the specified minimum experience.
Possible enum values:< 1
1 - 2
3 - 5
6 - 10
11 - 15
16 - 20
21 - 25
26 - 30
31 - 35
36 - 40
41 - 45
46 - 50
optional
boolean
Fetch only leads who have not been unlocked by your agency.
optional
phone
Fetch only leads with the specified phone number.
optional
enum
Sort by the specified field. Defaults to ascending order; for descending order, put a -
(hyphen) in front of the field name.
For example: -sent
would sort the leads in descending order based on the date/time they submitted their application to your agency.
id
name
state
license
sent
optional
date-time
Fetch only leads who submitted their application to your company or were unlocked after the specified date or date/time.
optional
date-time
Fetch only leads who were unlocked by your agency on or after the specified date or date/time.
optional
enum
Fetch only leads who reside in the specified state.
Possible enum values:AL
AK
AZ
AR
CA
CO
CT
DE
FL
GA
HI
ID
IL
IN
IA
KS
KY
LA
ME
MD
MA
MI
MN
MS
MO
MT
NE
NV
NH
NJ
NM
NY
NC
ND
OH
OK
OR
PA
RI
SC
SD
TN
TX
UT
VT
VA
WA
DC
WV
WI
WY
optional
enum
Fetch only leads of the specified travel status.
Possible enum values:Current Traveler
Previous Traveler
None
optional
email
Fetch only leads who were unlocked by the specified user.
optional
boolean
Fetch only leads of the specified work eligibility.
Example Request
Example Response
[
{
"id": 12345,
"first_name": "John",
"last_name": "Doe",
"address": "1234 Example Street",
"address2": "Suite 5678",
"city": "Louisville",
"state": "KY",
"zip": "40210",
"email": "[email protected]",
"phone": "1234567890",
"license": "OT",
"experience": "1 - 2",
"sent": "2015-12-08T15:24:35-05:00",
"has_job_apps": true
},
{
"id": 67890,
"first_name": "Jane",
"last_name": "Smith",
"address": "1234 Example Street",
"address2": "Suite 5678",
"city": "Lexington",
"state": "KY",
"zip": "40503",
"email": "[email protected]",
"phone": "1234657890",
"license": "RRT",
"experience": "3 - 5",
"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>
<address>1234 Example Street</address>
<address2>Suite 5678</address2>
<city>Louisville</city>
<state>KY</state>
<zip>40210</zip>
<email>[email protected]</email>
<phone>1234567890</phone>
<license>Echo+Tech</license>
<experience>11 - 15</experience>
<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>
<address>1234 Example Street</address>
<address2>Suite 5678</address2>
<city>Lexington</city>
<state>KY</state>
<zip>40503</zip>
<email>[email protected]</email>
<phone>1234657890</phone>
<license>CT+Tech</license>
<experience>16 - 20</experience>
<sent>2015-12-08T15:24:35-05:00</sent>
<has_job_apps></has_job_apps>
</lead>
</leads>
Retrieve a Lead
URL Parameters
REQUIRED
integer
The ID number of the lead you want to fetch.
Query Parameters
No parameters.
Example Request
Example Response
{
"id": 12345,
"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": "Interventional+Radiology",
"experience": "46 - 50",
"licensed_states": "Alabama",
"contact_time": "Morning",
"preferred_destinations": "California",
"preferred_cities": "Qui praesentium ratione alias qui et eum placeat. Nobis eos et dolorem omnis et laboriosam. Vitae cum soluta qui magnam veritatis.",
"license_number": "f1c3o2f2u9q5m3a7f3x5",
"license_state": "Arizona",
"license_date_issued": "12/20/1967",
"license_date_expires": "06/23/2002",
"license_investigated": "Yes",
"license_investigation_details": "",
"travel_status": "Previous Traveler",
"work_eligible": "No",
"employment_history": [
{
"company": "Example Company",
"state": "PA",
"phone": "1234567890",
"start_date": "2021-01-1",
"end_date": null
}
],
"job_applications": [
{
"job_id": 77786,
"title": "Example Job Title",
"reference": "EXAMPLE12356",
"is_direct_app": false,
"created_at": "1964-02-27T11:44:26+00:00"
}
],
"unlocked_by": "Smith, John",
"is_premium": true
}
<?xml version="1.0"?>
<leads>
<lead>
<id>12345</id>
<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>MRI+Tech</license>
<experience>21 - 25</experience>
<licensed_states>Mississippi</licensed_states>
<contact_time>Afternoon</contact_time>
<preferred_destinations>Ohio</preferred_destinations>
<preferred_cities>Ut molestiae mollitia quis sed hic. Ipsum delectus inventore aspernatur aut. Repellendus dicta a ducimus ut iste est deleniti.</preferred_cities>
<license_number>y0c4c3v4r7d0c5g0d4o2</license_number>
<license_state>Idaho</license_state>
<license_date_issued>08/28/1983</license_date_issued>
<license_date_expires>05/12/2003</license_date_expires>
<license_investigated>No</license_investigated>
<license_investigation_details></license_investigation_details>
<travel_status>None</travel_status>
<work_eligible>No</work_eligible>
<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>71647</job_id>
<title>Example Job Title</title>
<reference>EXAMPLE12356</reference>
<is_direct_app></is_direct_app>
<created_at>1941-09-27T20:15:56+00:00</created_at>
</job_applications>
<unlocked_by>Smith, John</unlocked_by>
<is_premium></is_premium>
</lead>
</leads>