Documentation :: AlliedTravelCareers.com

AlliedTravelCareers API v2.0

Leads

The leads resource is used to manage application data submitted by leads on AlliedTravelCareers.

List all leads

GET https://www.alliedtravelcareers.com/api/v2.0/leads.json GET https://www.alliedtravelcareers.com/api/v2.0/leads.xml

URL Parameters

No parameters.

Query Parameters

email optional email

Fetch only leads with the specified email address.

end_date optional date-time

Fetch only leads who submitted their application to your company or were unlocked before the specified date or date/time.

end_unlocked_date optional date-time

Fetch only leads who were unlocked by your agency on or before the specified date or date/time.

first_name optional string

Fetch only leads with the specified first name.

has_job_apps optional boolean

Fetch only leads who have (1) or have not (0) applied to one of your jobs.

job_title optional string

Fetch only leads who applied to a job of the specified title.

last_name optional string

Fetch only leads with the specified last name.

license optional enum

Fetch only leads with the specified license.

Possible enum values:
  • Anesthesia Technician
  • Audiologist
  • Board Certified Behavioral Analyst (BCBA) - School
  • Behavioral Health Tech
  • Behavioral Therapist
  • Cardiovascular Technologist (CVT)
  • Cath Lab Tech
  • Certified Occupational Therapist Assistant (COTA)
  • Clinical Lab Scientist (CLS)
  • Certified Respiratory Therapist (CRT)
  • Certified Surgical Technologist (CST)
  • CT Tech
  • CVOR Tech
  • Cytotechnologist / Cytogenetics
  • Dental Assistant
  • Dental Hygienist
  • Dialysis Tech
  • Dietician / Registered Dietician
  • Director of Rehab (DOR)
  • Dosimetrist
  • Dual-Modality Tech
  • Echo Tech
  • EEG Tech
  • EKG Tech
  • EP Tech / EP Lab Tech
  • Emergency Medical Technician (EMT)
  • Endo Tech / GI Tech
  • Hyperbaric Tech (HBOT)
  • Histo Tech
  • Interventional Radiology (IR)
  • Licensed Associate Counselor (LAC)
  • Licensed Clinical Social Worker (LCSW)
  • Licensed Professional Marriage Counselor
  • Licensed Independent Substance Abuse Counselor (LISAC)
  • Licensed Master Social Worker (LMSW)
  • Licensed Professional Counselor (LPC)
  • Licensed Professional Clinical Counselor (LPCC)
  • Licensed Social Worker (LSW)
  • Mammography Tech
  • Medical Assistant (MA)
  • Medical Laboratory Technician (MLT)
  • Medical Social Worker
  • Medical Technologist
  • Microbiology Tech
  • Monitor Tech
  • MRI Tech
  • Neurodiagnostic Tech
  • Neurophysiology Technologist
  • Non-Clinical Tech
  • Nuclear Medicine Tech
  • OB Tech
  • Occupational Therapist (OT)
  • Ophthalmic Technician
  • Orthopedic Tech
  • Occupational Therapist (OT) - School
  • Occupational Therapist Assistant (OTA)
  • Occupational Therapist Assistant (OTA) - School
  • Paramedic
  • Pathology Assistant
  • Patient Care Tech
  • Perfusionist
  • Pharmacist
  • Pharmacy Tech
  • Phlebotomist
  • Physical Therapist (PT)
  • Physical Therapy Assistant (PTA)
  • Polysomnographic / Sleep Tech
  • Psychiatric Tech
  • Psychologist - School
  • Psychology
  • Physical Therapist (PT) - School
  • Radiology Tech
  • Radiation Therapist
  • Recreational Therapist
  • Respiratory Therapy Technician
  • Registered Respiratory Therapist (RRT)
  • Surgical First Assistant (SFA)
  • Speech Language Pathologist (SLP) - School
  • Speech Language Pathology Assistant (SLPA)
  • Speech Language Pathology Assistant (SLPA) - School
  • Special Procedures Tech
  • Special Education Teacher (Sped Teacher)
  • Speech Language Pathologist (SLP)
  • Sterile Processing Tech
  • Surgical Tech
  • Technician / Technologist
  • Telemetry Tech
  • Ultrasound Tech
  • Vascular Tech
  • X-Ray Tech

licensed_states 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

lives_within_radius optional integer

Fetch only leads who live within the specified radius (in miles) of the location provided in lives_within_zip.

lives_within_zip optional string

Fetch only leads who live within the radius (in miles) provided in lives_within_radius of the specified location.

max optional integer

Maximum number of leads to return.

min_experience optional enum

Fetch only leads with at least the specified minimum experience.

Possible enum values:
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99

not_unlocked optional boolean

Fetch only leads who have not been unlocked by your agency.

phone optional phone

Fetch only leads with the specified phone number.

sort 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.

Possible enum values:
  • id
  • name
  • state
  • license
  • sent

start_date optional date-time

Fetch only leads who submitted their application to your company or were unlocked after the specified date or date/time.

start_unlocked_date optional date-time

Fetch only leads who were unlocked by your agency on or after the specified date or date/time.

state 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

unlocked_by optional email

Fetch only leads who were unlocked by the specified user.

Example Request

GET https://www.alliedtravelcareers.com/api/v2.0/leads.json GET https://www.alliedtravelcareers.com/api/v2.0/leads.xml

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": "Tele Tech",
        "experience": "4",
        "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": "LMSW",
        "experience": "99",
        "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>X-Ray Tech</license>
    <experience>27</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>Sped Teacher</license>
    <experience>92</experience>
    <sent>2015-12-08T15:24:35-05:00</sent>
    <has_job_apps></has_job_apps>
  </lead>
</leads>

Retrieve a Lead

GET https://www.alliedtravelcareers.com/api/v2.0/leads.json/:id GET https://www.alliedtravelcareers.com/api/v2.0/leads.xml/:id

URL Parameters

id REQUIRED integer

The ID number of the lead you want to fetch.

Query Parameters

No parameters.

Example Request

GET https://www.alliedtravelcareers.com/api/v2.0/leads.json/12345 GET https://www.alliedtravelcareers.com/api/v2.0/leads.xml/12345

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": "OTA - School",
    "experience": "44",
    "licensed_states": "Michigan",
    "contact_time": "Evening",
    "preferred_destinations": "Arkansas",
    "preferred_cities": "Nostrum aut ut expedita voluptate. Autem deleniti reiciendis id molestiae. Est molestiae tenetur nesciunt quo consequatur cumque.",
    "license_state": "Georgia",
    "license_date_issued": "03/07/1946",
    "license_date_expires": "01/02/1988",
    "license_investigated": "No",
    "license_investigation_details": "",
    "employment_history": [
        {
            "company": "Example Company",
            "state": "PA",
            "phone": "1234567890",
            "start_date": "2021-01-1",
            "end_date": null
        }
    ],
    "job_applications": [
        {
            "job_id": 75956,
            "title": "Example Job Title",
            "reference": "EXAMPLE12356",
            "is_direct_app": false,
            "created_at": "1942-07-29T09:10:49+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>Recreational Therapist</license>
    <experience>56</experience>
    <licensed_states>Colorado</licensed_states>
    <contact_time>Weekends</contact_time>
    <preferred_destinations>South Dakota</preferred_destinations>
    <preferred_cities>Aut illum illum et ipsum rerum recusandae. Dolorem blanditiis accusamus nesciunt aut. Repellat voluptatum dolores vel dolore et voluptas. Voluptatum laborum et hic ut.</preferred_cities>
    <license_state>Tennessee</license_state>
    <license_date_issued>05/28/1976</license_date_issued>
    <license_date_expires>10/01/1946</license_date_expires>
    <license_investigated>No</license_investigated>
    <license_investigation_details></license_investigation_details>
    <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>96935</job_id>
      <title>Example Job Title</title>
      <reference>EXAMPLE12356</reference>
      <is_direct_app>1</is_direct_app>
      <created_at>1940-10-03T23:36:54+00:00</created_at>
    </job_applications>
    <unlocked_by>Smith, John</unlocked_by>
    <is_premium></is_premium>
  </lead>
</leads>