Search API API Reference

The API allows for a constant stream of up-to-date job postings and provides the best matching based on any job seeker's search query. With the API, you use the Jobs2Careers enhanced search engine which has years of optimizations already built in. The API takes the guess work out of everything!

API Endpoint
https://api.jobs2careers.com/api
Schemes: https
Version: 1.0.2

Paths

Search

GET /search.php
id: integer
in query

Your unique Publisher ID (as shown in the Feed Manager)

pass: string
in query

Your unique Publisher Password (as shown in the Feed Manager)

ip: string
in query

The end user's IP address. Used for relevancy.

q: string
in query

URL encoded query string (keyword). Required if l is not present.

l: string
in query

Combination of city state (Austin,TX) or zipcode (78750). Required if q is not present.

start: integer x ≥ 0
in query

Start offset. Defaults to 0.

sort: string r, d
in query

Sort type:

  • r - By relevancy, from most to least relevant
  • d - By date, from most to least recent

Defaults to r.

format: string xml, json, php, html json
in query

Output format:

  • xml
  • json
  • php
  • html
m: integer 0, 1
in query

[Deprecated] Receive mobile optimized jobs only. Defaults to 0.

limit: integer 0 ≤ x ≤ 200
in query

Max number of results. Defaults to 10. Maximum is 200.

link: integer 0, 1
in query

Expose a direct link. Removes the onclick attribute and replaces it with a url attribute.

full_desc: integer 0, 1
in query

Include the full job description in the response

jobid: string
in query

[Deprecated] Query for a specific job. Changes the response model from JobSearch to JobArray. Replaced by the Job Status API.

jobtype: integer[]
in query

[Deprecated] Only include jobs with the given types:

  • 1: Full Time or Professional
  • 2: Part Time
  • 4: Gigs
Array values passed separated by comma: ?jobtype=aaa,bbb
uid: string
in query

MD5 hash of email. Rotates company impressions for a user.

pid: string
in query

[Deprecated] MD5 hash of email. Rotates company impressions for a user.

d: integer 20, 40, 80
in query

[Deprecated] Set the search radius in kilometers

useragent: string
in query

Pass in the user agent to prioritize jobs for mobile platforms

relevancy_weight: integer 0 ≤ x ≤ 100
in query

Control how much weight is placed on relevancy. Higher values reduce the weight that price has in ranking. Defaults to 0.

title: integer 0, 1
in query

Require the job title to include q. Defaults to 0.

major_category: integer x ≥ 0
in query

Only include jobs in the given major categories.

For a list of categories see the Classification API

Array values passed separated by pipe: ?major_category=aaa|bbb
minor_category: integer x ≥ 0
in query

Only include jobs in the given minor categories

For a list of categories see the Classification API

Array values passed separated by pipe: ?minor_category=aaa|bbb
t1: string (up to 32 chars)
in query

Tracking tag 1. Maximum length is 32 characters.

t2: string (up to 32 chars)
in query

Tracking tag 2. Maximum length is 32 characters.

t3: string (up to 32 chars)
in query

Tracking tag 3. Maximum length is 32 characters.

encrypt: integer 0, 1
in query

Enable/disable encryption of user information passed via query parameters.

logo: integer 0, 1
in query

Adds the logo_url attribute to the jobs in the response.

200 OK

Success

400 Bad Request

Bad request

Response Example (200 OK)
{
  "total": 4951,
  "start": 0,
  "count": 1,
  "jobs": [
    {
      "title": "Part Time Delivery Job - Earn up to $25/hr",
      "date": "2019-01-02T19:03:25Z",
      "onclick": "j2c_view(1895935481, 2429914811, 4316464402, undefined, undefined, undefined, undefined, undefined, undefined, '&job_loc=Austin%2CTX','2d04486c08affd792f75778ec21a4f10')",
      "company": "Shipt",
      "city": "Austin,TX",
      "description": "Shipt is a membership-based marketplace that helps people get the things they need, like fresh produce and household essentials, from stores they trust. Help people save time and have fun while you're at it - there's never been a better time to join",
      "price": "high",
      "preview": 0,
      "major_category0": "[Caregiving/Babysitting]",
      "minor_category0": "[Caregiving/Babysitting] Babysitter/Child Caregiver",
      "major_category1": "[Trucking]",
      "minor_category1": "[Trucking] Delivery Driver",
      "id": "5957639185"
    }
  ]
}
Response Example (400 Bad Request)
{
  "status": "string",
  "message": "string"
}

Schema Definitions

Error: object

status:
string
message:
string
Example
{
  "status": "string",
  "message": "string"
}

JobSearch: object

total:
integer
start:
integer
count:
integer
jobs:
JobArray
Example
{
  "total": 4951,
  "start": 0,
  "count": 1,
  "jobs": [
    {
      "title": "Part Time Delivery Job - Earn up to $25/hr",
      "date": "2019-01-02T19:03:25Z",
      "onclick": "j2c_view(1895935481, 2429914811, 4316464402, undefined, undefined, undefined, undefined, undefined, undefined, '&job_loc=Austin%2CTX','2d04486c08affd792f75778ec21a4f10')",
      "company": "Shipt",
      "city": "Austin,TX",
      "description": "Shipt is a membership-based marketplace that helps people get the things they need, like fresh produce and household essentials, from stores they trust. Help people save time and have fun while you're at it - there's never been a better time to join",
      "price": "high",
      "preview": 0,
      "major_category0": "[Caregiving/Babysitting]",
      "minor_category0": "[Caregiving/Babysitting] Babysitter/Child Caregiver",
      "major_category1": "[Trucking]",
      "minor_category1": "[Trucking] Delivery Driver",
      "id": "5957639185"
    }
  ]
}

JobArray: array

Job
Example
[
  {
    "title": "string",
    "date": "string",
    "onclick": "string",
    "url": "string",
    "company": "string",
    "city": [
      "string"
    ],
    "description": "string",
    "price": "string",
    "preview": "integer",
    "id": "string",
    "major_category0": "string",
    "major_category1": "string",
    "minor_category0": "string",
    "minor_category1": "string",
    "logo_url": "string",
    "ad_type": "string"
  }
]

Job: object

title:
string
date:
string
onclick:
string
url:
string
company:
string
city:
string[]
string
description:
string
price:
string
preview:
integer
id:
string
major_category0:
string
major_category1:
string
minor_category0:
string
minor_category1:
string
logo_url:
string
ad_type:
string
Example
{
  "title": "string",
  "date": "string",
  "onclick": "string",
  "url": "string",
  "company": "string",
  "city": [
    "string"
  ],
  "description": "string",
  "price": "string",
  "preview": "integer",
  "id": "string",
  "major_category0": "string",
  "major_category1": "string",
  "minor_category0": "string",
  "minor_category1": "string",
  "logo_url": "string",
  "ad_type": "string"
}