Skip to main content

Job Feeds

Accepted File Formats​

We can accept a job feed in any of the following file formats:

  • JSON (preferred)
  • XML
  • CSV

Job Data Fields​

These are the fields that you can provide for each job in your feed. The names of the fields can be anything you want, as long as they are consistent.

Required Fields​

Job ID

  • Type: string or number
  • This field is used to differentiate the jobs in your feed. You cannot use the same Job ID more than once in the feed.
  • This would most likely be the ID that is used for the job in the originating system/database.
  • Examples:
    • 1372946
    • "XYZ-8432437"
    • "5833c492-20b4-4500-9a2c-92017c07b6e0"

Title

  • Type: string
  • This is the job's title.
  • Examples:
    • "Neurosurgeon Needed in Dallas, TX"
    • "Hospitalist Opportunity in Los Angeles, California"

Description

  • Type: string
  • This is the job's description.
  • We accept HTML and plain text in this field. If HTML is provided, we allow most tags related to basic styling, such as bullet lists <ul> and <li> or making text bold <b> and <strong>. However, some HTML tags such as images <img> and anchor links <a> get automatically removed during our import process.

Specialty IDs

  • Type: array of numbers
  • We provide a list of all of our available specialties and their corresponding IDs as a CSV file here: https://www.hospitalrecruiting.com/api/available-specialties-for-jobs
  • For a job that falls under just one specialty, you can provide one ID number. For a job that falls under multiple specialties, you should provide all matching ID numbers, separated by commas.
  • Examples:
    • For a Family Medicine job: 23
    • For a Cardiology NP or General NP job: 487, 403

Country

  • Type: string
  • This can be the country's full name, or its 3-letter or 2-letter abbreviation.
  • Examples:
    • "United States" or "USA" or "US"
    • "Japan" or "JPN" or "JP"

State

  • Type: string
  • This can be the state's full name, or its abbreviation.
  • Examples:
    • "Indiana" or "IN"
    • "Texas" or "TX"

City

  • Type: string
  • This should be the city's full name.
  • Examples:
    • "Los Angeles"
    • "Dallas"
    • "Indianapolis"

Optional Fields​

Street Address

  • Type: string
  • Examples:
    • "4325 E 3rd St"
    • "1600 Pennsylvania Avenue NW"

Postal Code

  • Type: string or number
  • This should be the postal/zip code relevant to the country the job is located in.
  • Examples:
    • 47401 (a zip code in Bloomington, Indiana, United States)
    • "150-0002" (a postal code in Shibuya, Tokyo, Japan)

Compensation Type

  • Type: string (enum)
  • Provide only one of the following values:
    • "HOURLY" - The employee is paid hourly
    • "WEEKLY" - The employee is paid weekly
    • "YEARLY" - The employee is paid with an annual salary

Pay Range Minimum

  • Type: number
  • This value is the job's minimum pay amount in United States cents.
  • In order to provide this field, you must also provide the "Compensation Type" field.
  • If the pay amount is a single value instead of a range, you can provide the same value in this field and the "Pay Range Maximum" field.
  • Examples:
    • For a job paid $40.15-$50.00 per hour: 4015
    • For a job with an annual salary of $75,000-$80,000: 7500000

Pay Range Maximum

  • Type: number
  • This value is the job's maximum pay amount in United States cents.
  • In order to provide this field, you must also provide the "Compensation Type" field.
  • If the pay amount is a single value instead of a range, you can provide the same value in this field and the "Pay Range Minimum" field.
  • Examples:
    • For a job paid $40.15-$50.00 per hour: 5000
    • For a job with a salary of $75,000-$80,000: 8000000

Time Type

  • Type: string (enum)
  • Provide only one of the following values:
    • "FULL_TIME"
    • "PART_TIME"
    • "PRN" (as in "pro re nata" or "per diem")

Duration Type

  • Type: string (enum)
  • Provide only one of the following values:
    • "PERMANENT"
    • "TEMPORARY"

Location Type

  • Type: string (enum)
  • Provide only one of the following values:
    • "IN_PERSON"
    • "REMOTE"
    • "HYBRID"

Contact Email Address

  • Type: string
  • This is the email address of the person who manages the job or who job seekers should contact, such as a recruiter's email address.
  • We use this field and the other "Contact" fields below to create and assign Contact Profiles to your jobs on HospitalRecruiting.com. These allow job seekers to see the appropriate contact information when viewing your jobs.
  • Examples:
    • "mary.sue@recruitingcompany.com"
    • "john-smith@gmail.com"

Contact Name

  • Type: string
  • This is the name of the person who manages the job or who job seekers should contact, such as a recruiter's name.
  • Examples:
    • "Mary Sue"
    • "John Smith"

Contact Phone Number

  • Type: string or number
  • This is the phone number of the person who manages the job or who job seekers should contact, such as a recruiter's phone number.
  • In order to provide this field, you must also provide either "Contact Email Address" or "Contact Name".
  • There is no strict format the phone number must be in, as long as it is human-readable.
  • Examples:
    • 8002447236
    • "800-244-7236"
    • "+1 (800) 244-7236"

Organization Name

  • Type: string
  • This is the name of the job's organization. This is useful if some of your jobs are split up between different companies or organizations. If all of your jobs are part of the same organization, there is no need to provide this field.
  • We can use this field to assign each job to one of the Organization Profiles in your account on HospitalRecruiting.com.
  • Examples:
    • "Something Healthcare"
    • "My Cool Recruiting Company"

Community Name

  • Type: string
  • This is the name of the job's community, which is typically just the name of the job's location.
  • We can use this field to assign each job to one of the Community Profiles in your account on HospitalRecruiting.com.
  • Examples:
    • "Dallas, TX"
    • "Bloomington, IN"

External Apply URL

  • Type: string
  • This is the url where job seekers can apply to the job. If this field is provided, job seekers will be redirected from our website to this url when applying to the job on HospitalRecruiting.com.
  • Examples:
    • "somejobsite.com/job/328949237498/"
    • "somejobboard.net/apply/1247493/?utm_source=hospitalrecruiting"

Feed Examples​

Here are some examples in which all job fields are provided.

JSON

[
  {
    "id": "ABC-123456",
    "title": "Neurosurgeon Needed in Dallas, TX",
    "description": "This is a <strong>very cool</strong> job.",
    "specialties": [
      487,
      403,
      23
    ],
    "country": "US",
    "state": "TX",
    "city": "Dallas",
    "address": "2301 Flora St",
    "postal_code": 75201,
    "compensation_type": "HOURLY",
    "min_pay": 3550,
    "max_pay": 3800,
    "time_type": "PART_TIME",
    "duration_type": "TEMPORARY",
    "location_type": "IN_PERSON",
    "contact_email": "mary.sue@recruitingcompany.com",
    "contact_name": "Mary Sue",
    "contact_phone": "8002447236",
    "organization": "My Cool Recruiting Company",
    "community": "Dallas, TX",
    "apply_url": "somejobboard.net/apply/1247493/?utm_source=hospitalrecruiting"
  }
]

XML

<?xml version="1.0" encoding="UTF-8"?>
<jobs>
  <job>
    <id>ABC-123456</id>
    <title>Neurosurgeon Needed in Dallas, TX</title>
    <description><![CDATA[This is a <strong>very cool</strong> job.]]></description>
    <specialties>487,403,23</specialties>
    <country>US</country>
    <state>TX</state>
    <city>Dallas</city>
    <address>2301 Flora St</address>
    <postal_code>75201</postal_code>
    <compensation_type>HOURLY</compensation_type>
    <min_pay>3550</min_pay>
    <max_pay>3800</max_pay>
    <time_type>PART_TIME</time_type>
    <duration_type>TEMPORARY</duration_type>
    <location_type>IN_PERSON</location_type>
    <contact_email>mary.sue@recruitingcompany.com</contact_email>
    <contact_name>Mary Sue</contact_name>
    <contact_phone>8002447236</contact_phone>
    <organization>My Cool Recruiting Company</organization>
    <community>Dallas, TX</community>
    <apply_url>somejobboard.net/apply/1247493/?utm_source=hospitalrecruiting</apply_url>
  </job>
</jobs>

CSV

id,title,description,specialties,country,state,city,postal_code,address,compensation_type,min_pay,max_pay,time_type,duration_type,location_type,contact_email,contact_name,contact_phone,organization,community,apply_url
"ABC-123456","Neurosurgeon Needed in Dallas, TX","This is a <strong>very cool</strong> job.","487,403,23","US","TX","Dallas","75201","2301 Flora St","HOURLY","3550","3800","PART_TIME","TEMPORARY","IN_PERSON","mary.sue@recruitingcompany.com","Mary Sue","8002447236","My Cool Recruiting Company","Dallas, TX","somejobboard.net/apply/1247493/?utm_source=hospitalrecruiting"

If you have any questions, contact us at info@hospitalrecruiting.com.