Documentation :: TravelNurseSource.com

TravelNurseSource API v2.0

Leads

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

List all leads

GET https://qa-sit.travelnursesource.com/api/v2.0/leads.json GET https://qa-sit.travelnursesource.com/api/v2.0/leads.xml

URL Parameters

No parameters.

Query Parameters

certifications optional enum

Fetch only leads with the specified certifications.

Possible enum values:
  • ACLS
  • BLS
  • NRP
  • PALS

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:
  • Registered Nurse (RN)
  • Licensed Practical / Licensed Vocational Nurse (LPN/LVN)
  • Certified Nurse Assistant (CNA)

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://qa-sit.travelnursesource.com/api/v2.0/leads.json GET https://qa-sit.travelnursesource.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": "johndoe@test.com",
        "phone": "1234567890",
        "license": "CNA",
        "experience": "35",
        "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": "janesmith@test.com",
        "phone": "1234657890",
        "license": "LPN / LVN",
        "experience": "42",
        "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>johndoe@test.com</email>
    <phone>1234567890</phone>
    <license>LPN / LVN</license>
    <experience>61</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>janesmith@test.com</email>
    <phone>1234657890</phone>
    <license>LPN / LVN</license>
    <experience>75</experience>
    <sent>2015-12-08T15:24:35-05:00</sent>
    <has_job_apps></has_job_apps>
  </lead>
</leads>

Retrieve a Lead

GET https://qa-sit.travelnursesource.com/api/v2.0/leads.json/:id GET https://qa-sit.travelnursesource.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://qa-sit.travelnursesource.com/api/v2.0/leads.json/12345 GET https://qa-sit.travelnursesource.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": "johndoe@test.com",
    "phone": "+1234567890",
    "license": "CNA",
    "experience": "39",
    "certification": "NRP",
    "specialties": "Med/Surg / Ortho",
    "contact_time": "Morning",
    "preferred_destinations": "Connecticut",
    "preferred_cities": "Sapiente rerum tempora praesentium amet nostrum. Provident qui similique quas ex voluptas.",
    "licensed_states": "South Dakota",
    "license_state": "Connecticut",
    "license_date_issued": "09/26/1946",
    "license_date_expires": "06/29/1989",
    "license_investigated": "Yes",
    "license_investigation_details": "",
    "employment_history": [
        {
            "company": "Example Company",
            "state": "PA",
            "phone": "1234567890",
            "start_date": "2021-01-01",
            "end_date": null
        }
    ],
    "job_applications": [
        {
            "job_id": 75587,
            "title": "Example Job Title",
            "reference": "EXAMPLE12356",
            "is_direct_app": true,
            "created_at": "1976-08-09T11:17:50+00:00"
        }
    ],
    "unlocked_by": "Smith, John",
    "is_premium": 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></address2>
    <city>Louisville</city>
    <state>KY</state>
    <zip>40210</zip>
    <sent>2015-12-08T15:24:35-05:00</sent>
    <email>johndoe@test.com</email>
    <phone>+1234567890</phone>
    <license>CNA</license>
    <experience>13</experience>
    <certification>NRP</certification>
    <specialties>ER/Trauma</specialties>
    <contact_time>Morning</contact_time>
    <preferred_destinations>Vermont</preferred_destinations>
    <preferred_cities>Dolores minima blanditiis cum illum rerum mollitia animi. Ut ut quam dolor qui sed beatae. Ut enim repudiandae voluptatibus est quisquam ea reprehenderit est.</preferred_cities>
    <licensed_states>Kentucky</licensed_states>
    <license_state>Wisconsin</license_state>
    <license_date_issued>12/20/1993</license_date_issued>
    <license_date_expires>06/12/1945</license_date_expires>
    <license_investigated>Yes</license_investigated>
    <license_investigation_details></license_investigation_details>
    <employment_history>
      <company>Example Company</company>
      <state>PA</state>
      <phone>1234567890</phone>
      <start_date>2021-01-01</start_date>
      <end_date></end_date>
    </employment_history>
    <job_applications>
      <job_id>10783</job_id>
      <title>Example Job Title</title>
      <reference>EXAMPLE12356</reference>
      <is_direct_app></is_direct_app>
      <created_at>2007-04-25T04:57:36+00:00</created_at>
    </job_applications>
    <unlocked_by>Smith, John</unlocked_by>
    <is_premium>1</is_premium>
  </lead>
</leads>