Introduction

This is the API documentation for the YMCareers. API is organized around REST with JSON responses. It is designed to work over authenticated, HTTPS secured channels.

NAVIGATING THIS REFERENCE: You can view general integration instructions in this central, light blue section. In the dark area to the right, you can see code examples with cURL and JSON response.

To access the API you will need a valid API user. Please go to Access Request for detailed information about how to request an API user account.

Access Request

Access to the API requires a valid API user account. Please have a contracted career center contact send an email to the YM Careers integrations team at careersintegrations@communitybrands.com to request an API user account, and include the following information:

Site Name(s)
Site ID(s)
Email
Primary Contact First Name
Primary Contact Last Name
Company Name (if different from site name)
Scope(s)

Authentication

Your API ENDPOINT is https://{ENDPOINT}/. Note the {ENDPOINT} is different for different environments.

API End Points are :

Production: https://api.careerwebsite.com/v1
Beta: https://api-beta.careerwebsite.com/v1
Staging: https://api-stg.careerwebsite.com/v1

# With shell, you can just pass the correct header with each request
curl "ENDPOINT" \
  -H "Authorization: {API_ACCESS_TOKEN}" OR "X-API-KEY: {API_ACCESS_KEY}"

Every API request must be authenticated with either an API_ACCESS_TOKEN or an API_ACCESS_KEY.

Authorization: <API_ACCESS_TOKEN> This token expires in 15 minutes so you will need to create a new token by using Create API Access Token every 15 minutes. If you need to get an access token, you can obtain it by using Get API Access Token. Calling Get API Access Token API doesn't guarantee it will return a token which has not expired. Both Create API Access Token and Get API Access Token are included in this documentation.

X-API-KEY: <API_ACCESS_KEY> This API key will never expire. You will need to create a new API access key by using Create API Access Key. If you need to get an existing API access key previously created, you can obtain it by using Get API Access Key. Both Create API Access Key and Get API Access Key are included in this documentation.

You must replace API_ACCESS_TOKEN with your own token or API_ACCESS_KEY with your own API access key.

Scope

Scope allows users to access particular resources of the application. For example Job Posting scope allows you to access all requests needed to post a job. To request a scope for your api user account you need to contact the YM Careers via email: careersintegrations@communitybrands.com

You can request to following scopes for your API user account.

Scope Alias	Scope Name	Description
job-search	Job Search	All endpoints are needed to search a job
location-services	Geo Location Services	All endpoints for geo location services
lead-generation	Lead Generation Service	All endpoints for getting non member lead list
job-seeker-activity	Job Seeker Activity Data Service	All endpoints for getting job seeker activity data
job-seeker-event-reporting	Job Seeker Event Reporting Service	All endpoints for getting report on job seeker events
recruiter-event-reporting	Recruiter Event Reporting Service	All endpoints for getting report on recruiter events

API Access Token

Create API Access Token

Create a new API_ACCESS_TOKEN for a registered user by username and password.

Note: API Access Token is valid for 15 minutes. After 15 minutes, the token will expire and you need to create a new API Access Token.

curl -X POST \
  https://{ENDPOINT}/api/api-access-token \
  -F username={USERNAME} \
  -F password={PASSWORD}

HTTP Request

POST /api/api-access-token

{
  "status": "success",
  "data": {
    "token": "<API_ACCESS_TOKEN>"
  },
  "message": "",
  "code": 200
}

Headers

Content-Type: application/json

Body Parameters

Parameter	Type	Required/Optional	Description
username	string	required	A non-empty username string of registered user
password	string	required	A non-empty password string of registered user

Get API Access Token

Get a previously created API access token for a registered user by using username and password.

Note: API Access Token is valid for 15 minutes. It is possible to get an expired token by using Get API Access Token. If it is expired, any API call with expired token will return 401 as HTTP status code. You will need to create new API Access Token by using Create API Access Token API.

curl -X GET \
  'https://{ENDPOINT}/api/api-access-token?username={username}
  &password={password}'

HTTP Request

GET /api/api-access-token?username={USERNAME}&password={PASSWORD}

Headers

Content-Type: application/json

{
  "status": "success",
  "data": {
    "token": "<API_ACCESS_TOKEN>"
  },
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
username	string	required	A valid non-empty string containing the username of the registered user
password	string	required	A valid non-empty string containing the password of the registered user

API Access Key

Create API Access Key

Create a new API_ACCESS_KEY for a registered user by username and password.

Note: API access key will never expire. You can use the same API access key multiple times.

curl -X POST \
  https://{ENDPOINT}/api/api-access-key \
  -F username={USERNAME} \
  -F password={PASSWORD}

HTTP Request

POST /api/api-access-key

{
  "status": "success",
  "data": {
    "key": "<API_ACCESS_KEY>"
  },
  "message": "",
  "code": 200
}

Headers

Content-Type: application/json

Body Parameters

Parameter	Type	Required/Optional	Description
username	string	required	A non-empty username string of registered user
password	string	required	A non-empty password string of registered user

Get API Access Key

Get a previously created API access key for a registered user by using username and password.

Note: API access key will never expire. So this API will get an active API access key. If an API access key is not available for the requested user then you should create a new API access key by using the Create API Access Key API.

curl -X GET \
  'https://{ENDPOINT}/api/api-access-key?username={username}
  &password={password}'

HTTP Request

GET /api/api-access-key?username={USERNAME}&password={PASSWORD}

Headers

Content-Type: application/json

{
  "status": "success",
  "data": {
    "key": "<API_ACCESS_KEY>"
  },
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
username	string	required	A valid non-empty string containing the username of the registered user
password	string	required	A valid non-empty string containing the password of the registered user

Recruiter

Create Recruiter

curl -X POST \
  https://{ENDPOINT}/careers/recruiter \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}' \
  -F email={EMAIL} \
  -F site_id={SITE_ID} \
  -F first_name={FIRST_NAME} \
  -F last_name={LAST_NAME} \
  -F phone={PHONE} \
  -F company={COMPANY} \
  -F organization_type={ORGANISATION_TYPE} \
  -F city={CITY} \
  -F state={STATE} \
  -F country={COUNTRY} \
  -F password={PASSWORD}

HTTP Request

POST /careers/recruiter

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password


{
    "status": "success",
    "data": [
        {
            "recruiter_id": 12345
            "first_name": "Demo",
            "last_name": "Demo",
            "password": null,
            "title": null,
            "phone": "123456789",
            "employer_type": "",
            "address": null,
            "city": "",
            "state": "",
            "zip": null,
            "country": "",
            "is_member": false,
            "member_number": null,
            "member_type": "",
            "email": "example@example.com",
            "site_id": 12345,
            "company": null,
            "industry": null,
            "is_active": true,
            "is_validated": false,
            "is_banned": false,
            "added_date": "2017-09-09T23:45:45Z",
            "updated_date": null
        }
    ],
    "message": "",
    "code": 200
}

Body Parameters

Parameter	Type	Required/Optional	Description
email	string	required	A valid non-empty email address
site_id	integer	required	A valid registered site ID must comply with regex: [0-9]+
first_name	string	required	A valid non-empty string containing a first name value
last_name	string	required	A valid non-empty string containing a last name value
phone	string	required	A valid non-empty string containing a phone number value
company	string	required	A valid non-empty string containing a company name value
organization_type	string	required	A valid non-empty string value; must be employer, recruiter or ad agency
city	string	required	A valid non-empty string containing a city value
state	string	required	A valid non-empty string containing a state value
country	string	required	A valid non-empty string containing a country value
password	string	required	A valid non-empty string containing a password value

Recruiter Token

Create Recruiter Token

Create a new recruiter access token for a registered recruiter by using email and site ID.

Note: Recruiter Access Token is valid for 15 minutes. After 15 minutes you will need to create Recruiter Access Token again.

curl -X POST \
  https://{ENDPOINT}/careers/recruiter-token \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}' \
  -F site_id={SITE_ID} \
  -F email={email}

HTTP Request

POST /careers/recruiter-token

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": {
    "token": "<RECRUITER_TOKEN>"
  },
  "message": "",
  "code": 200
}

Body Parameters

Parameter	Type	Required/Optional	Description
email	string	required	A valid non-empty email address registered as a recruiter on the site
site_id	integer	required	A valid registered site ID must comply with regex: [0-9]+

Get Recruiter Token

Get a previously created valid recruiter token by using email address and site ID.

Note: Recruiter Access Token is valid for 15 minutes. So it is possible to get an expired token by using Get Recruiter Token API. If it has expired, you will need to create new Recruiter Token by using Create Recruiter Token API

curl -X GET \
  'https://{ENDPOINT}/careers/recruiter-token?email={EMAIL}&site_id={SITE_ID}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /careers/recruiter-token?email={EMAIL}&site_id={SITE_ID}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": {
    "token": "<RECRUITER_TOKEN>"
  },
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
email	string	required	A valid non-empty email address registered as a recruiter with the site
site_id	integer	required	A valid registered site ID must comply with regex: [0-9]+

Lead Generation

Get New NonMember List By Site ID

Get a list of nonmember recruiters and/or candidates of a particular site by using site ID.

curl -X GET \
  'https://{ENDPOINT}/lead-generation/non-member-list?site_id={SITE_ID}&&start_date={START_DATE}&end_date={END_DATE}user_type={USER_TYPE}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /lead-generation/non-member-list?site_id={SITE_ID}&start_date={START_DATE}&end_date={END_DATE}&user_type={USER_TYPE}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "partner_id": 12345,
      "site_id": 67646,
      "site_name": "APA",
      "user_type": "Candidate",
      "id": 5774,
      "email": "demo@demo.com",
      "joined_date": "2018-03-14T07:56:00Z",
      "first_name": "Sample",
      "last_name": "Sample",
      "phone": null,
      "extension": null,
      "fax": null,
      "address1": null,
      "address2": null,
      "city": null,
      "zip": null,
      "country": null,
      "state": null,
      "member_number": "4345",
      "last_login": "2018-03-22T10:19:00Z",
      "allow_contact": true,
      "posted_resume": true,
      "has_applied_jobs": true,
      "has_job_alerts": false,
      "title": null,
      "company_name": null,
      "is_member": false,
      "has_job_posting": false,
      "has_company_profile": false,
      "has_contact_resume": false,
      "has_resume_subscription": false
    },
    {
      "partner_id": 12345,
      "site_id": 67646,
      "site_name": "APA",
      "user_type": "Employer",
      "id": 343556,
      "email": "example@example.com",
      "joined_date": "2018-03-15T05:11:00Z",
      "first_name": "West",
      "last_name": "West",
      "phone": "1111111111",
      "extension": null,
      "fax": null,
      "address1": "75 Barnet Road",
      "address2": null,
      "city": null,
      "zip": null,
      "country": "United Kingdom",
      "state": null,
      "member_number": "3445543",
      "last_login": "2018-03-15T05:11:00Z",
      "allow_contact": true,
      "posted_resume": false,
      "has_applied_jobs": false,
      "has_job_alerts": false,
      "title": null,
      "company_name": "demo company",
      "is_member": false,
      "has_job_posting": false,
      "has_company_profile": false,
      "has_contact_resume": false,
      "has_resume_subscription": false
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
site_id	integer	required	A valid registered site_id must comply with regex: [0-9]+
start_date	string	optional(default value current date minus 30 days )	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be less than up to 30 days only from end date
end_date	string	optional (default value current date )	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$
user_type	string	optional (default value candidate \| recruiter )	A valid string containing either candidate or recruiter

Get New NonMember List By PartnerId

Get list of nonmember recruiters and candidates of particular partner by using partner ID.

curl -X GET \
  'https://{ENDPOINT}/lead-generation/non-member-list?partner_id={PARTNER_ID}&&start_date={START_DATE}&end_date={END_DATE}user_type={USER_TYPE}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /lead-generation/non-member-list?partner_id={PARTNER_ID}&start_date={START_DATE}&end_date={END_DATE}&user_type={USER_TYPE}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "partner_id": 12345,
      "site_id": 67646,
      "site_name": "APA",
      "user_type": "Candidate",
      "id": 586896,
      "email": "demo@test.com",
      "joined_date": "2018-03-14T07:56:00Z",
      "first_name": "Demo",
      "last_name": "Demo",
      "phone": null,
      "extension": null,
      "fax": null,
      "address1": null,
      "address2": null,
      "city": null,
      "zip": null,
      "country": null,
      "state": null,
      "member_number": "993948",
      "last_login": "2018-03-22T10:19:00Z",
      "allow_contact": true,
      "posted_resume": true,
      "has_applied_jobs": true,
      "has_job_alerts": false,
      "title": null,
      "company_name": null,
      "is_member": false,
      "has_job_posting": false,
      "has_company_profile": false,
      "has_contact_resume": false,
      "has_resume_subscription": false
    },
    {
      "partner_id": 12345,
      "site_id": 67646,
      "site_name": "APA",
      "user_type": "Employer",
      "id": 243435,
      "email": "abc@abc.com",
      "joined_date": "2018-03-15T05:11:00Z",
      "first_name": "Jay",
      "last_name": "Wade",
      "phone": "7777777777",
      "extension": null,
      "fax": null,
      "address1": "75 Barnet Road",
      "address2": null,
      "city": null,
      "zip": null,
      "country": "United Kingdom",
      "state": null,
      "member_number": "8908",
      "last_login": "2018-03-15T05:11:00Z",
      "allow_contact": true,
      "posted_resume": false,
      "has_applied_jobs": false,
      "has_job_alerts": false,
      "title": null,
      "company_name": "demo company",
      "is_member": false,
      "has_job_posting": false,
      "has_company_profile": false,
      "has_contact_resume": false,
      "has_resume_subscription": false
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
partner_id	integer	required	A valid integer ID of the partner from whose job boards you want the non members data must comply with regex: [0-9]+
start_date	string	optional(default value current date minus 30 days )	A valid date string; must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be less than up to 30 days only from end date
end_date	string	optional (default value current date )	A valid date string; must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$
user_type	string	optional (default value candidate\|recruiter )	A valid string containing either candidate or recruiter

Location Autocomplete

Get Location Autocomplete Suggestions By Input

Get location autocomplete suggestions using query parameters. Suggestions sorted by location type (City, State, and Country).

Note: This service is only available for integrations within Community Brands. External requests for this scope will not be granted.


curl -X GET \
  'https://{ENDPOINT}/gateway/auto-complete?input={INPUT}&ip={IP}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /gateway/auto-complete?input={INPUT}&ip={IP}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "location_type": "state",
      "location_completion": "city=$state=Hawaii$country=United States",
      "completion_hash": "b4dffc9f83bd89e6bc49bff5c2877563",
      "city": null,
      "state": "Hawaii",
      "state_abbr": "HI",
      "country": "United States",
      "country_abbr": "US",
      "rank": 1
    },
    {
      "location_type": "city",
      "location_completion": "city=Harper$state=Washington$country=United States",
      "completion_hash": "3f5df47bc3da1ae55f1aba4e9f422a1e",
      "city": "Harper",
      "state": "Washington",
      "state_abbr": "WA",
      "country": "United States",
      "country_abbr": "US",
      "rank": 10
    },
    {
      "location_type": "city",
      "location_completion": "city=Humptulips$state=Washington$country=United States",
      "completion_hash": "9a14953613a650af239153511a0b5ed0",
      "city": "Humptulips",
      "state": "Washington",
      "state_abbr": "WA",
      "country": "United States",
      "country_abbr": "US",
      "rank": 20
    },
    {
      "location_type": "city",
      "location_completion": "city=Hamilton$state=Washington$country=United States",
      "completion_hash": "9c3300d273b3a6f6e787b3685966e6b5",
      "city": "Hamilton",
      "state": "Washington",
      "state_abbr": "WA",
      "country": "United States",
      "country_abbr": "US",
      "rank": 30
    },
    {
      "location_type": "city",
      "location_completion": "city=Home$state=Washington$country=United States",
      "completion_hash": "47e72fb2c3075a59ec943554c5818cbb",
      "city": "Home",
      "state": "Washington",
      "state_abbr": "WA",
      "country": "United States",
      "country_abbr": "US",
      "rank": 40
    },
    {
      "location_type": "city",
      "location_completion": "city=Harrah$state=Washington$country=United States",
      "completion_hash": "efc0478b1b0bf2976b66fdf1d4aa9cf7",
      "city": "Harrah",
      "state": "Washington",
      "state_abbr": "WA",
      "country": "United States",
      "country_abbr": "US",
      "rank": 50
    },
    {
      "location_type": "city",
      "location_completion": "city=Hartline$state=Washington$country=United States",
      "completion_hash": "c8724dffa9a1deae70977bed2b4e192c",
      "city": "Hartline",
      "state": "Washington",
      "state_abbr": "WA",
      "country": "United States",
      "country_abbr": "US",
      "rank": 60
    },
    {
      "location_type": "city",
      "location_completion": "city=Harrington$state=Washington$country=United States",
      "completion_hash": "010f34896f061ad298087ca79c83d0f1",
      "city": "Harrington",
      "state": "Washington",
      "state_abbr": "WA",
      "country": "United States",
      "country_abbr": "US",
      "rank": 70
    },
    {
      "location_type": "country",
      "location_completion": "city=$state=$country=Croatia",
      "completion_hash": "8e303f8c19973296d877e12b163018b5",
      "city": null,
      "state": null,
      "state_abbr": null,
      "country": "Croatia",
      "country_abbr": "HR",
      "rank": 100
    },
    {
      "location_type": "country",
      "location_completion": "city=$state=$country=Haiti",
      "completion_hash": "cfdb2decbef5bf65cd537c92b376209a",
      "city": null,
      "state": null,
      "state_abbr": null,
      "country": "Haiti",
      "country_abbr": "HT",
      "rank": 200
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
input	string	required	A valid non-empty string containing a city and/or state and/or country value
ip	string	optional	A valid string containing an IP address

(Legacy) Get AutoComplete Location as State and City By Zip Code (USA Zip Code Only)

Get autocomplete location as city and state using zip code (USA zip code only).

Note: New API is available for autocomplete location. Please check it out here Get Location Autocomplete Suggestions By Input

  curl -X GET \
  'https://{ENDPOINT}/api/auto-complete?input={INPUT}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP request

GET /api/auto-complete?input={INPUT}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "city": "Ocala",
      "state": "FL",
      "country": "United States",
      "latitude": 29.1571921,
      "longitude": -82.1223977,
      "place_id": "ChIJFSgEVzvT54gR0Cfi-gajrq8"
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
input	integer	required	A valid 5 digit zipcode

(Legacy) Get Autocomplete Location as City and State By Latitude and Longitude

Get autocomplete location as city and state using latitude and longitude.

Note: New API is available for autocomplete location. Please check it out here Get Location Autocomplete Suggestions By Input


 curl -X GET \
  'https://{ENDPOINT}/api/pinpoint?lat={LAT}&lng=-{LONG}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP request

GET /api/pinpoint?lat={LAT}&lng={LONG}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": {
    "city": "Brooklyn",
    "state": "NY",
    "country": "United States",
    "latitude": 40.7142205,
    "longitude": -73.9612903,
    "place_id": "ChIJd8BlQ2BZwokRAFUEcm_qrcA"
  },
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
lat	integer	required	A valid latitude value
lng	integer	required	A valid longitude value

(Legacy) Get Autocomplete Location as City and State

Get autocomplete location as city and state using the name of the city and/or state.

Note: New API is available for autocomplete location. Please check it out here Get Location Autocomplete Suggestions By Input

  curl -X GET \
  'https://{ENDPOINT}/api/auto-complete?input={INPUT}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP request

GET /api/auto-complete?input={INPUT}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "city": "Tampa",
      "state": "FL",
      "country": "USA",
      "latitude": null,
      "longitude": null,
      "place_id": "ChIJ4dG5s4K3wogRY7SWr4kTX6c"
    },
    {
      "city": "Tamarac",
      "state": "FL",
      "country": "USA",
      "latitude": null,
      "longitude": null,
      "place_id": "ChIJs4w8mUoE2YgRl5UCT39i5k8"
    },
    {
      "city": "Tampico",
      "state": "Tamaulipas",
      "country": "Mexico",
      "latitude": null,
      "longitude": null,
      "place_id": "ChIJHy3-_Iv914UR5omwncOaGMM"
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
input	string	required	A valid non-empty string containing a city and/or state value

Job Search

Get job search results using query parameters

Get job search results using query parameters.

curl -X GET \
   'https://{ENDPOINT}/gateway/job-search?site_id={SITE_ID}&q={Q}&start={START}&rows={ROWS}&sort={SORT}&radius={RADIUS}&ip={IP}&user_agent={USER_AGENT}&include_backfill={INCLUDE_BACKFILL}&location_type={LOCATION_TYPE}&location_completion={LOCATION_COMPLETION}' \
   -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /gateway/job-search?site_id={SITE_ID}&q={Q} &start={START}&rows={ROWS}&sort={SORT}&radius={RADIUS} &ip={IP}&user_agent={USER_AGENT} &include_backfill={INCLUDE_BACKFILL}&location_type={LOCATION_TYPE} &location_completion={LOCATION_COMPLETION}

{
  "status": "success",
  "data": {
    "num_found": 1,
    "num_organic": 1,
    "num_backfill": 0,
    "start": 0,
    "rows": 100,
    "docs": [
      {
        "id": "38629417",
        "sitejobid": "178087683_22852",
        "position": "Coupon Testing",
        "site_id": "22852",
        "city": ["Tampa", "Tampa"],
        "country": ["United States", "United States"],
        "industry": ["Computer Software"],
        "location": [
          "Tampa, Florida, United States",
          "Tampa, Florida, United States"
        ],
        "region": [" ", " "],
        "state": ["Florida", "Florida"],
        "zip": [" ", "33601"],
        "company": "Yourmembership",
        "duration": "1-2 Years",
        "education": "Master's Degree",
        "entrylevel": false,
        "experience": "3-5 Years",
        "function": ["Quality Assurance"],
        "sort": 1139264215,
        "contact_email": "demo@demo.com",
        "contact_phone": null,
        "contact_name": null,
        "jobpool": false,
        "anonymous": null,
        "state_abbr": ["FL", "FL"],
        "country_abbr": ["US", "US"],
        "internship": false,
        "job_category": null,
        "rank": null,
        "powerpost": false,
        "spotlight": true,
        "origin_site_id": "22852",
        "job_type": "Full-Time",
        "recruiter_id": "871193",
        "salary": null,
        "salary_currency": null,
        "salary_high": "100.00",
        "salary_low": "80.00",
        "salary_type": "Hourly Wage",
        "security": null,
        "travel": "50-75%",
        "careerfair": false,
        "description": "<p>This is NOT a real job. &nbsp;</p> <p>This is for testing purposes ONLY. &nbsp;</p> <p>Please do NOT apply for this job unless a member of YM internal team and using it for testing purposes.</p> <p>Thank you and have a wonderful day!!!</p> <p><span style=\"text-decoration: underline;\"><em><strong>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ut dignissim lectus. Donec nec nisi sagittis, auctor metus ut, placerat purus. Aliquam mi tellus, posuere vel ex at, rhoncus vestibulum nunc. Cras facilisis tortor non orci facilisis, vitae accumsan erat fermentum. Donec lacinia orci id semper porttitor. Suspendisse fringilla tempus porttitor. Vestibulum eu orci ut libero lacinia volutpat non vel nunc. Nam eu metus sed elit semper semper eget non dolor. Donec blandit enim id quam viverra aliquam. Praesent ultrices, ligula quis pretium porta, lacus felis mattis ligula, pretium auctor erat turpis id urna. Aliquam erat volutpat. Phasellus ut odio in felis sollicitudin eleifend non vel ligula. Duis vulputate sollicitudin dui. Praesent fringilla elementum mauris non bibendum.</strong></em></span></p> <p><span style=\"text-decoration: underline;\"><em><strong>Sed nec nisl suscipit, tincidunt felis non, feugiat lacus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin sodales libero sed sapien facilisis aliquam. Vivamus nec elit et orci faucibus sodales. Fusce risus libero, aliquam quis euismod nec, interdum ut libero. Nam viverra, sem ultricies ornare viverra, ex mi condimentum sapien, et pellentesque urna leo et nisl. Ut vehicula nulla ut leo bibendum aliquet. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla quis nibh at metus fringilla finibus in ut est. Nulla et dui rhoncus, varius elit bibendum, fermentum velit. Suspendisse potenti.</strong></em></span></p> <p><span style=\"text-decoration: underline;\"><em><strong>Mauris ultricies est ut nunc euismod, quis fermentum magna mollis. Vivamus dignissim velit leo, interdum eleifend ex volutpat nec. Mauris cursus arcu a felis ullamcorper efficitur. Donec non dapibus nulla. In sit amet orci ultricies, convallis sem eu, bibendum leo. Integer ultrices ullamcorper nunc ut sollicitudin. Nullam tempus turpis eget aliquet feugiat. Interdum et malesuada fames ac ante ipsum primis in faucibus. Ut sem mauris, rutrum at rhoncus nec, posuere non ante. Nullam pharetra imperdiet felis. Nullam consequat libero justo, ut feugiat tortor ullamcorper vel.</strong></em></span></p> <p><span style=\"text-decoration: underline;\"><em><strong>Nullam efficitur vitae turpis nec hendrerit. Nam nunc lorem, viverra eget laoreet in, euismod in nunc. In hac habitasse platea dictumst. Nulla augue quam, scelerisque ac tellus quis, blandit viverra quam. In porta pharetra tempus. Aenean turpis dolor, bibendum at est et, ultrices tempus quam. Donec imperdiet egestas tortor, id auctor neque interdum id. Integer vitae odio ornare, efficitur dolor eu, ultrices massa. Fusce mi turpis, suscipit ac felis non, sollicitudin finibus nunc.</strong></em></span></p> <p><span style=\"text-decoration: underline;\"><em><strong>Sed vulputate porttitor justo non venenatis. Vestibulum pretium purus a commodo tincidunt. Quisque suscipit libero ac sapien accumsan, non efficitur libero ultrices. Morbi eleifend dui id dolor semper posuere. Donec posuere pretium neque, vel rhoncus enim condimentum ut. In hac habitasse platea dictumst. Nulla sagittis urna at ligula mollis, ut feugiat tellus vestibulum. Quisque lectus sem, feugiat non purus sed, lobortis ullamcorper leo. Nunc convallis, turpis nec ultrices vulputate, augue quam commodo ligula, quis feugiat risus felis eu purus. Fusce non nulla ac nulla rhoncus viverra. Phasellus consectetur nisl ut lacinia consequat. Interdum et malesuada fames ac ante ipsum primis in faucibus. Morbi quis efficitur turpis. In pellentesque luctus dolor eu elementum.</strong></em></span></p>",
        "latitude": "27.996097564697",
        "longitude": "-82.58203125",
        "geo": ["27.996097564697,-82.58203125"],
        "network_vertical": null,
        "requirements": "<p><em><span style=\"text-decoration: underline;\"><strong>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque ut dignissim lectus. Donec nec nisi sagittis, auctor metus ut, placerat purus. Aliquam mi tellus, posuere vel ex at, rhoncus vestibulum nunc. Cras facilisis tortor non orci facilisis, vitae accumsan erat fermentum. Donec lacinia orci id semper porttitor. Suspendisse fringilla tempus porttitor. Vestibulum eu orci ut libero lacinia volutpat non vel nunc. Nam eu metus sed elit semper semper eget non dolor. Donec blandit enim id quam viverra aliquam. Praesent ultrices, ligula quis pretium porta, lacus felis mattis ligula, pretium auctor erat turpis id urna. Aliquam erat volutpat. Phasellus ut odio in felis sollicitudin eleifend non vel ligula. Duis vulputate sollicitudin dui. Praesent fringilla elementum mauris non bibendum.</strong></span></em></p> <p><em><span style=\"text-decoration: underline;\"><strong>Sed nec nisl suscipit, tincidunt felis non, feugiat lacus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Proin sodales libero sed sapien facilisis aliquam. Vivamus nec elit et orci faucibus sodales. Fusce risus libero, aliquam quis euismod nec, interdum ut libero. Nam viverra, sem ultricies ornare viverra, ex mi condimentum sapien, et pellentesque urna leo et nisl. Ut vehicula nulla ut leo bibendum aliquet. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla quis nibh at metus fringilla finibus in ut est. Nulla et dui rhoncus, varius elit bibendum, fermentum velit. Suspendisse potenti.</strong></span></em></p> <p><em><span style=\"text-decoration: underline;\"><strong>Mauris ultricies est ut nunc euismod, quis fermentum magna mollis. Vivamus dignissim velit leo, interdum eleifend ex volutpat nec. Mauris cursus arcu a felis ullamcorper efficitur. Donec non dapibus nulla. In sit amet orci ultricies, convallis sem eu, bibendum leo. Integer ultrices ullamcorper nunc ut sollicitudin. Nullam tempus turpis eget aliquet feugiat. Interdum et malesuada fames ac ante ipsum primis in faucibus. Ut sem mauris, rutrum at rhoncus nec, posuere non ante. Nullam pharetra imperdiet felis. Nullam consequat libero justo, ut feugiat tortor ullamcorper vel.</strong></span></em></p> <p><em><span style=\"text-decoration: underline;\"><strong>Nullam efficitur vitae turpis nec hendrerit. Nam nunc lorem, viverra eget laoreet in, euismod in nunc. In hac habitasse platea dictumst. Nulla augue quam, scelerisque ac tellus quis, blandit viverra quam. In porta pharetra tempus. Aenean turpis dolor, bibendum at est et, ultrices tempus quam. Donec imperdiet egestas tortor, id auctor neque interdum id. Integer vitae odio ornare, efficitur dolor eu, ultrices massa. Fusce mi turpis, suscipit ac felis non, sollicitudin finibus nunc.</strong></span></em></p> <p><em><span style=\"text-decoration: underline;\"><strong>Sed vulputate porttitor justo non venenatis. Vestibulum pretium purus a commodo tincidunt. Quisque suscipit libero ac sapien accumsan, non efficitur libero ultrices. Morbi eleifend dui id dolor semper posuere. Donec posuere pretium neque, vel rhoncus enim condimentum ut. In hac habitasse platea dictumst. Nulla sagittis urna at ligula mollis, ut feugiat tellus vestibulum. Quisque lectus sem, feugiat non purus sed, lobortis ullamcorper leo. Nunc convallis, turpis nec ultrices vulputate, augue quam commodo ligula, quis feugiat risus felis eu purus. Fusce non nulla ac nulla rhoncus viverra. Phasellus consectetur nisl ut lacinia consequat. Interdum et malesuada fames ac ante ipsum primis in faucibus. Morbi quis efficitur turpis. In pellentesque luctus dolor eu elementum.</strong></span></em></p>",
        "source": "posted",
        "source_id": null,
        "apply_online": true,
        "apply_url": "https://www.yourmembership.com/company/open-positions/",
        "job_url": "https://www.yourmembership.com/company/open-positions/",
        "language": null,
        "posted_date": "2018-09-24T18:17:00Z",
        "expire_date": "2018-11-23T19:16:55Z",
        "start_date": "2018-09-24T18:16:55Z",
        "updated": null,
        "featured": true,
        "preferred": true,
        "feature_logo": "No",
        "veteransupgrade": 1,
        "diversityupgrade": 1,
        "socialupgrade": 1,
        "link": null,
        "is_saved": false,
        "isbackfill": false,
        "web_url": "https://srv-stp-jtcfd2.corp.yourmembership.com/job/coupon-testing/38629417/22852/",
        "member_posted": false,
        "latlon": "27.996097564697,-82.58203125"
      }
    ]
  },
  "message": "",
  "code": 200
}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

Query Parameters

Parameter	Type	Required/Optional	Description
site_id	integer	required	A valid registered site ID must comply with regex: [0-9]+.
q	string	required	A valid string containing keywords to search the data.
start	integer	optional (default value is 0)	A valid integer number must comply with regex: [0-9]+. The start parameter is used to identify the starting point to return rows from a result set.
rows	integer	optional (default value is 10)	A valid integer number of records to be returned must comply with regex: [0-9]+.
sort	string	optional (default value is sort desc)	A valid string containing sort method. It should be either sort desc or sort asc.
radius	integer	required (default value is 200 miles)	A valid numerical radius value is required when location type is a city.
ip	string	optional	A valid string containing an IP address.
user_agent	string	optional	A valid string which containing information about users system and browser.
include_internal_backfill	integer	optional (default value is 0)	Allowed values are 0 or 1. When the value is 1 then Job Search API will return jobs from the job board as well as the jobs from the internal source set up as backfill on that site. If internal backfill is not enabled on that particular site then internal backfill jobs will not be included in results set.
include_backfill	integer	optional (default value is 1)	Allowed values are 0 or 1. When the value is 1 then Job Search API will return jobs from the job board as well as the jobs from the external source set up as backfill on that site. If external backfill is not enabled on that particular site then external backfill jobs will not be included in results set.
location_type	string	optional	A valid string containing job location type. Location type should be city/state/country.
location_completion	string	optional	A valid string containing job location. Format should be city={CITY}$state={STATE}$country={COUNTRY}

Job Seeker Activity

Get Resume Data For All Job Seekers By Site ID

Get details of resume data for all job seekers by site ID within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/careers/integration/resume-activity?site_id={SITE_ID}&start_date={START_DATE}&end_date={END_DATE}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /careers/integration/resume-activity?site_id={SITE_ID}&start_date={START_DATE}&end_date={END_DATE}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "resume_id": 7654321,
      "file_name": "resume.pdf",
      "added_date": "2017-01-30T20:35:21Z",
      "updated_date": "2017-02-13T14:06:35Z",
      "is_public": false,
      "highest_education_level": "Bachelor's Degree",
      "recent_career_level": "Student (Undergraduate)",
      "candidate_id": 1234566,
      "site_id": 13363,
      "candidate_email": "west@test.com",
      "candidate_first_name": "West",
      "candidate_last_name": "West",
      "candidate_phone": null,
      "candidate_address": null,
      "candidate_address2": null,
      "candidate_city": null,
      "candidate_state": null,
      "candidate_zip": null,
      "candidate_country": null
    },
    {
      "resume_id": 7654322,
      "file_name": "resume.pdf",
      "added_date": "2017-01-30T20:35:21Z",
      "updated_date": "2017-02-18T14:06:35Z",
      "is_public": false,
      "highest_education_level": "Bachelor's Degree",
      "recent_career_level": "Student (Undergraduate)",
      "candidate_id": 1234567,
      "site_id": 13363,
      "candidate_email": "sample@test.com",
      "candidate_first_name": "Sample",
      "candidate_last_name": "Sample",
      "candidate_phone": null,
      "candidate_address": null,
      "candidate_address2": null,
      "candidate_city": null,
      "candidate_state": null,
      "candidate_zip": null,
      "candidate_country": null
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
site_id	integer	required	A valid registered site ID must comply with regex: [0-9] +
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$

Get Resume Data For All Job Seekers By Partner ID

Get details of resume data for all job seekers by partner ID within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/careers/integration/resume-activity?partner_id={PARTNER_ID}&start_date={START_DATE}&end_date={END_DATE}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /careers/integration/resume-activity?partner_id={PARTNER_ID}&start_date={START_DATE}&end_date={END_DATE}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "resume_id": 23456788,
      "file_name": "resume.pdf",
      "added_date": "2017-01-30T16:42:43Z",
      "updated_date": "2017-01-30T16:46:16Z",
      "is_public": false,
      "highest_education_level": "Bachelor's Degree",
      "recent_career_level": "Experienced (non-Manager)",
      "candidate_id": 4567788,
      "site_id": 13363,
      "candidate_email": "sample@test.com",
      "candidate_first_name": "Sample",
      "candidate_last_name": "Sample",
      "candidate_phone": null,
      "candidate_address": null,
      "candidate_address2": null,
      "candidate_city": null,
      "candidate_state": null,
      "candidate_zip": null,
      "candidate_country": null
    },
    {
      "resume_id": 23456789,
      "file_name": "resume.pdf",
      "added_date": "2017-01-30T14:54:24Z",
      "updated_date": "2017-01-30T14:54:24Z",
      "is_public": false,
      "highest_education_level": "High School",
      "recent_career_level": "Entry-Level",
      "candidate_id": 4567789,
      "site_id": 13363,
      "candidate_email": "west@demo.com",
      "candidate_first_name": "West",
      "candidate_last_name": "West",
      "candidate_phone": null,
      "candidate_address": null,
      "candidate_address2": null,
      "candidate_city": null,
      "candidate_state": null,
      "candidate_zip": null,
      "candidate_country": null
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
partner_id	integer	required	A valid registered partner ID must comply with regex: [0-9] +
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$

Get Job Apply Data For All Job Seekers By Site ID

Get details of the job applications, including application date, method; job seeker name, email address; job company name, location, position title, etc. for all job seekers' job board and email applications by site ID within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/careers/integration/jobs-applied-activity?site_id={SITE_ID}&start_date={START_DATE}&end_date={END_DATE}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /careers/integration/jobs-applied-activity?site_id={SITE_ID}&start_date={START_DATE}&end_date={END_DATE}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "job_applied_id": 9876543,
      "candidate_id": 7654321,
      "first_name": "West",
      "last_name": "West",
      "email": "west@demo.com",
      "job_applied_date": "2017-01-30T14:38:00Z",
      "job_application_method": "Job Board",
      "job_title": "Mechanical/Marine Engineer",
      "job_company_name": "Demo Company",
      "job_location_country": "United States",
      "job_location_state": "Pennsylvania",
      "job_location_city": "Philadelphia",
      "job_location_zip": null,
      "job_position": "Mechanical/Marine Engineer",
      "job_industry": null,
      "job_function": "Engineering",
      "job_type": null
    },
    {
      "job_applied_id": 9876543,
      "candidate_id": 7654322,
      "first_name": "Sample",
      "last_name": "Sample",
      "email": "sample@test.com",
      "job_applied_date": "2017-01-28T08:43:00Z",
      "job_application_method": "Job Board",
      "job_title": "Software Engineer",
      "job_company_name": "The Sample Group",
      "job_location_country": "United States",
      "job_location_state": "Pennsylvania",
      "job_location_city": "Philadelphia",
      "job_location_zip": null,
      "job_position": "Software Engineer",
      "job_industry": null,
      "job_function": "Engineering",
      "job_type": null
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
site_id	integer	required	A valid registered site ID must comply with regex: [0-9] +
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$

Get Job Apply Data For All Job Seekers By Partner ID

curl -X GET \
  'https://{{ENDPOINT}}/careers/integration/jobs-applied-activity?partner_id={PARTNER_ID}&start_date={START_DATE}&end_date={END_DATE}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /careers/integration/jobs-applied-activity?partner_id={PARTNER_ID}&start_date={START_DATE}&end_date={END_DATE}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "job_applied_id": 9988771,
      "candidate_id": 7766551,
      "first_name": "West",
      "last_name": "West",
      "email": "west@demo.com",
      "job_applied_date": "2017-01-30T14:38:00Z",
      "job_application_method": "Job Board",
      "job_title": "Software Engineer",
      "job_company_name": "The Sample Group",
      "job_location_country": "United States",
      "job_location_state": "Pennsylvania",
      "job_location_city": "Philadelphia",
      "job_location_zip": null,
      "job_position": "Software Engineer",
      "job_industry": null,
      "job_function": "Engineering",
      "job_type": null
    },
    {
      "job_applied_id": 9988772,
      "candidate_id": 7766552,
      "first_name": "Sample",
      "last_name": "Sample",
      "email": "sample@test.com",
      "job_applied_date": "2017-01-28T08:43:00Z",
      "job_application_method": "Job Board",
      "job_title": "Chief Engineer",
      "job_company_name": "My Company",
      "job_location_country": "United States",
      "job_location_state": "Oregon",
      "job_location_city": "Coos Bay",
      "job_location_zip": null,
      "job_position": "Chief Engineer",
      "job_industry": null,
      "job_function": "Seagoing",
      "job_type": "Full-Time"
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
partner_id	integer	required	A valid registered partner ID must comply with regex: [0-9] +
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be of future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$

Get Job Alert Data By Site ID

Get details of job alert data by site ID and within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/careers/integration/job-alert-activity?site_id={SITE_ID}&start_date={START_DATE}&end_date={END_DATE}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /careers/integration/job-alert-activity?site_id={SITE_ID}&start_date={START_DATE}&end_date={END_DATE}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "job_alert_id": 34556678,
      "job_alert_keywords": "",
      "job_alert_radius_search_parameter": null,
      "job_alert_name": "Island Tug and Barge 02-Dec-2016",
      "job_alert_status": "inactive",
      "added_date": "2016-12-02T12:33:00Z",
      "expiration_date": "2036-12-02T05:00:00Z",
      "job_alert_frequency": "weekly",
      "job_alert_filters": [
        {
          "field": "country",
          "values": ["Brunei Darussalam"],
          "type": "select"
        }
      ]
    },
    {
      "job_alert_id": 3400009,
      "job_alert_keywords": "",
      "job_alert_radius_search_parameter": null,
      "job_alert_name": "Engineer 02-Dec-2016",
      "job_alert_status": "inactive",
      "added_date": "2016-12-02T14:28:00Z",
      "expiration_date": "2036-12-02T05:00:00Z",
      "job_alert_frequency": "weekly",
      "job_alert_filters": []
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
site_id	integer	required	A valid registered site ID must comply with regex: [0-9] +
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$

Get Job Alert Data By Partner ID

Get details of job alert data by partner ID within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/careers/integration/job-alert-activity?partner_id={PARTNER_ID}&start_date={START_DATE}&end_date={END_DATE}' \
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /careers/integration/job-alert-activity?partner_id={PARTNER_ID}&start_date={START_DATE}&end_date={END_DATE}

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

{
  "status": "success",
  "data": [
    {
      "job_alert_id": 4233900,
      "job_alert_keywords": "",
      "job_alert_radius_search_parameter": {
        "location_completion": "city=$state=Florida$country=United States",
        "location_type": "state",
        "location_text": "Florida, United States"
      },
      "job_alert_name": "Test",
      "job_alert_status": "active",
      "added_date": "2018-12-05T19:42:00Z",
      "expiration_date": "2038-12-05T05:00:00Z",
      "job_alert_frequency": "daily",
      "job_alert_filters": [
        {
          "field": "function",
          "values": ["Entry-Level"],
          "type": "select"
        },
        {
          "field": "sector",
          "values": ["International: NGOs, Consulting, Multilaterals"],
          "type": "select"
        },
        {
          "field": "state",
          "values": ["Colorado"],
          "type": "select"
        },
        {
          "field": "country",
          "values": ["United States"],
          "type": "select"
        }
      ]
    },
    {
      "job_alert_id": 3445566,
      "job_alert_keywords": "",
      "job_alert_radius_search_parameter": null,
      "job_alert_name": "Island Tug and Barge 02-Dec-2016",
      "job_alert_status": "inactive",
      "added_date": "2016-12-02T12:33:00Z",
      "expiration_date": "2036-12-02T05:00:00Z",
      "job_alert_frequency": "weekly",
      "job_alert_filters": [
        {
          "field": "country",
          "values": ["Brunei Darussalam"],
          "type": "select"
        }
      ]
    }
  ],
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
partner_id	integer	required	A valid registered partner ID must comply with regex: [0-9] +
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$

Job Seeker Event Reporting

Get Job Seeker Event Report For All Job Seekers By Site ID

Get report of event data for all job seekers by site ID within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/event-tracking/job-seeker-event-reporting?site_id={SITE_ID}&event_type={EVENT_TYPE}&start_date={START_DATE}&end_date={END_DATE}&start={START}&rows={ROWS}&sort={SORT}'\
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /event-tracking/job-seeker-event-reporting?site_id={SITE_ID}&event_type={EVENT_TYPE}&start_date={START_DATE}&end_date={END_DATE}&start={START}&rows={ROWS}&sort={SORT}'

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

Response

The event_hash field returned in the API response is the unique identifier of a particular event.

{
  "status": "success",
  "data": {
    "num_found": 105,
    "start_date": "2019-04-01T00:00:00Z",
    "end_date": "2019-04-30T23:59:59Z",
    "start": 0,
    "rows": 50,
    "start_date": "2019-03-23T14:39:37Z",
    "end_date": "2019-04-22T14:39:37Z",
    "docs": [
      {
        "user_id": 123,
        "first_name": "test",
        "last_name": "test",
        "email": "demo@test.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36",
        "ip_address": "10.10.10.10",
        "user_type": "candidate",
        "site_id": 1,
        "partner_id": 123,
        "event_type": "job_seeker_login",
        "event_date": "2019-04-02T06:04:08Z",
        "event_hash": "xxx1245"
      },
      {
        "user_id": 456,
        "first_name": "test",
        "last_name": "test",
        "email": "demo@test.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
        "ip_address": "10.10.10.10",
        "user_type": "candidate",
        "site_id": 1,
        "partner_id": 123,
        "event_type": "job_seeker_job_search",
        "event_date": "2019-04-17T12:15:00Z",
        "event_hash": "95xxx09600",
        "location": [
          {
            "state": "FL",
            "city": "Tampa",
            "country": "United States"
          }
        ],
        "keyword": "test",
        "job_function": ["Design", "Consultant"],
        "industry": ["Computer Software", "Consulting"]
      },
      {
        "user_id": 789,
        "first_name": "test",
        "last_name": "test",
        "email": "demo@test.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36",
        "ip_address": "10.10.10.10",
        "user_type": "candidate",
        "site_id": 1,
        "partner_id": 101,
        "event_type": "job_seeker_job_apply",
        "event_date": "2019-04-02T06:04:08Z",
        "event_hash": "xxx4567",
        "company_name": "Test Company",
        "job_application_id": "102030",
        "position": "Test Position",
        "job_type": "Full-Time",
        "location": [
          {
            "state": "Alabama",
            "city": "Huntsville",
            "country": "United States"
          }
        ]
      }
    ]
  },
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
site_id	integer	required	A valid registered site ID must comply with regex: [0-9]+
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$
start	integer	optional (default value is 0)	A valid integer number must comply with regex: [0-9]+. The start parameter is used to identify the starting point to return rows from a result set.
rows	integer	optional (default value is 50)	A valid integer indicating number of records to be returned. Must comply with regex: [0-9]+. The maximum value is 200.
sort	string	optional (default value is event_date:asc)	A valid string should be in the format FIELD_NAME:SORT_ORDER. Sort order can be ASC or DESC. The valid field names are user_agent, ip_address, event_type, user_id and event_date
event_type	string	optional (default value is blank)	A valid event type. Valid event types are job_seeker_job_apply, job_seeker_job_search, job_seeker_login, job_seeker_logout, job_seeker_signup

Get Job Seeker Event Report For All Job Seekers By Partner ID

Get report of event data for all job seekers by partner ID within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/event-tracking/job-seeker-event-reporting?partner_id={PARTNER_ID}&event_type={EVENT_TYPE}&start_date={START_DATE}&end_date={END_DATE}&start={START}&rows={ROWS}&sort={SORT}'\
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /event-tracking/job-seeker-event-reporting?partner_id={PARTNER_ID}&event_type={EVENT_TYPE}&start_date={START_DATE}&end_date={END_DATE}&start={START}&rows={ROWS}&sort={SORT}'

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

Response

The event_hash field returned in the API response is the unique identifier of a particular event.

{
  "status": "success",
  "data": {
    "num_found": 105,
    "start_date": "2019-04-01T00:00:00Z",
    "end_date": "2019-04-30T23:59:59Z",
    "start": 0,
    "rows": 50,
    "start_date": "2019-03-23T14:39:37Z",
    "end_date": "2019-04-22T14:39:37Z",
    "docs": [
      {
        "user_id": 123,
        "first_name": "test",
        "last_name": "test",
        "email": "demo@test.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36",
        "ip_address": "10.10.10.10",
        "user_type": "candidate",
        "site_id": 1,
        "partner_id": 123,
        "event_type": "job_seeker_login",
        "event_date": "2019-04-02T06:04:08Z",
        "event_hash": "xxx1245"
      },
      {
        "user_id": 456,
        "first_name": "test",
        "last_name": "test",
        "email": "demo@test.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
        "ip_address": "10.10.10.10",
        "user_type": "candidate",
        "site_id": 1,
        "partner_id": 123,
        "event_type": "job_seeker_job_search",
        "event_date": "2019-04-17T12:15:00Z",
        "event_hash": "95xxx09600",
        "location": [
          {
            "state": "FL",
            "city": "Tampa",
            "country": "United States"
          }
        ],
        "keyword": "test",
        "job_function": ["Design", "Consultant"],
        "industry": ["Computer Software", "Consulting"]
      },
      {
        "user_id": 789,
        "first_name": "test",
        "last_name": "test",
        "email": "demo@test.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36",
        "ip_address": "10.10.10.10",
        "user_type": "candidate",
        "site_id": 1,
        "partner_id": 101,
        "event_type": "job_seeker_job_apply",
        "event_date": "2019-04-02T06:04:08Z",
        "event_hash": "xxx4567",
        "company_name": "Test Company",
        "job_application_id": "102030",
        "position": "Test Position",
        "job_type": "Full-Time",
        "location": [
          {
            "state": "Alabama",
            "city": "Huntsville",
            "country": "United States"
          }
        ]
      }
    ]
  },
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
partner_id	integer	required	A valid registered partner ID must comply with regex: [0-9]+
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$
start	integer	optional (default value is 0)	A valid integer number must comply with regex: [0-9]+. The start parameter is used to identify the starting point to return rows from a result set.
rows	integer	optional (default value is 50)	A valid integer indicating number of records to be returned. Must comply with regex: [0-9]+. The maximum value is 200.
sort	string	optional (default value is event_date:asc)	A valid string should be in the format FIELD_NAME:SORT_ORDER. Sort order can be ASC or DESC. The valid field names are user_agent, ip_address, event_type, user_id and event_date
event_type	string	optional (default value is blank)	A valid event type. Valid event types are job_seeker_job_apply, job_seeker_job_search, job_seeker_login, job_seeker_logout, job_seeker_signup

Recruiter Event Reporting

Get Recruiter Event Report For All Recruiters By Site ID

Get report of event data for all recruiter by site ID within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/event-tracking/recruiter-event-reporting?site_id={SITE_ID}&event_type={EVENT_TYPE}&start_date={START_DATE}&end_date={END_DATE}&start={START}&rows={ROWS}&sort={SORT}'\
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /event-tracking/recruiter-event-reporting?site_id={SITE_ID}&event_type={EVENT_TYPE}&start_date={START_DATE}&end_date={END_DATE}&start={START}&rows={ROWS}&sort={SORT}'

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

Response

The event_hash field returned in the API response is the unique identifier of a particular event.

{
  "status": "success",
  "data": {
    "num_found": 105,
    "start_date": "2019-04-01T00:00:00Z",
    "end_date": "2019-04-30T23:59:59Z",
    "start": 0,
    "rows": 50,
    "start_date": "2019-03-23T14:39:37Z",
    "end_date": "2019-04-22T14:39:37Z",
    "docs": [
      {
        "user_id": 1344,
        "first_name": "jose",
        "last_name": "gomez",
        "email": "areciogomez69@aol.com",
        "user_agent": null,
        "ip_address": null,
        "user_type": "recruiter",
        "site_id": 22858,
        "partner_id": 987,
        "event_type": "recruiter_login",
        "event_date": "2020-05-14T12:15:00Z",
        "event_hash": "645f4a508a0b989394217fbfc15f202c"
      },
      {
        "user_id": 1344,
        "first_name": "jose",
        "last_name": "gomez",
        "email": "areciogomez69@aol.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
        "ip_address": "192.168.0.1",
        "user_type": "recruiter",
        "site_id": 22858,
        "partner_id": 987,
        "event_type": "recruiter_logout",
        "event_date": "2020-05-14T12:15:00Z",
        "event_hash": "c5fb54e58766644c278ef5f06c0c20b7"
      },
      {
        "user_id": 308,
        "first_name": "sybil",
        "last_name": "saint-prix",
        "email": "ssantprix@nyc.rr.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
        "ip_address": "192.168.0.1",
        "user_type": "recruiter",
        "site_id": 22858,
        "partner_id": 987,
        "event_type": "recruiter_signup",
        "event_date": "2020-05-14T12:15:00Z",
        "event_hash": "b88a451a7eeb354a0bd7efbdc362faf8"
      }
    ]
  },
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
site_id	integer	required	A valid registered site ID must comply with regex: [0-9]+
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$
start	integer	optional (default value is 0)	A valid integer number must comply with regex: [0-9]+. The start parameter is used to identify the starting point to return rows from a result set.
rows	integer	optional (default value is 50)	A valid integer indicating number of records to be returned. Must comply with regex: [0-9]+. The maximum value is 200.
sort	string	optional (default value is event_date:asc)	A valid string should be in the format FIELD_NAME:SORT_ORDER. Sort order can be ASC or DESC. The valid field names are user_agent, ip_address, event_type, user_id and event_date
event_type	string	optional (default value is blank)	A valid event type. Valid event types are recruiter_login, recruiter_logout, recruiter_signup

Get Recruiter Event Report For All Recruiters By Partner ID

Get report of event data for all recruiter by partner ID within the specified date range.

curl -X GET \
  'https://{{ENDPOINT}}/event-tracking/recruiter-event-reporting?partner_id={PARTNER_ID}&event_type={EVENT_TYPE}&start_date={START_DATE}&end_date={END_DATE}&start={START}&rows={ROWS}&sort={SORT}'\
  -H 'Authorization: {API_ACCESS_TOKEN}' Or 'X-API-KEY: {API_ACCESS_KEY}'

HTTP Request

GET /event-tracking/recruiter-event-reporting?partner_id={PARTNER_ID}&event_type={EVENT_TYPE}&start_date={START_DATE}&end_date={END_DATE}&start={START}&rows={ROWS}&sort={SORT}'

Headers

Authorization: <API_ACCESS_TOKEN> Note: API access token created using Create API Access Token or obtained by using Get API Access Token By Username and Password Or
X-API-KEY: <API_ACCESS_KEY> Note: API access key created using Create API Access Key or obtained by using Get API Access Key By Username and Password

Response

The event_hash field returned in the API response is the unique identifier of a particular event.

{
  "status": "success",
  "data": {
    "num_found": 105,
    "start_date": "2019-04-01T00:00:00Z",
    "end_date": "2019-04-30T23:59:59Z",
    "start": 0,
    "rows": 50,
    "start_date": "2019-03-23T14:39:37Z",
    "end_date": "2019-04-22T14:39:37Z",
    "docs": [
      {
        "user_id": 1344,
        "first_name": "jose",
        "last_name": "gomez",
        "email": "areciogomez69@aol.com",
        "user_agent": null,
        "ip_address": null,
        "user_type": "recruiter",
        "site_id": 22858,
        "partner_id": 987,
        "event_type": "recruiter_login",
        "event_date": "2020-05-14T12:15:00Z",
        "event_hash": "645f4a508a0b989394217fbfc15f202c"
      },
      {
        "user_id": 1344,
        "first_name": "jose",
        "last_name": "gomez",
        "email": "areciogomez69@aol.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
        "ip_address": "192.168.0.1",
        "user_type": "recruiter",
        "site_id": 22858,
        "partner_id": 987,
        "event_type": "recruiter_logout",
        "event_date": "2020-05-14T12:15:00Z",
        "event_hash": "c5fb54e58766644c278ef5f06c0c20b7"
      },
      {
        "user_id": 308,
        "first_name": "sybil",
        "last_name": "saint-prix",
        "email": "ssantprix@nyc.rr.com",
        "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
        "ip_address": "192.168.0.1",
        "user_type": "recruiter",
        "site_id": 22858,
        "partner_id": 987,
        "event_type": "recruiter_signup",
        "event_date": "2020-05-14T12:15:00Z",
        "event_hash": "b88a451a7eeb354a0bd7efbdc362faf8"
      }
    ]
  },
  "message": "",
  "code": 200
}

Query Parameters

Parameter	Type	Required/Optional	Description
partner_id	integer	required	A valid registered partner ID must comply with regex: [0-9]+
start_date	string	optional (default value is current date minus 30 days)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$. Start date can be within 30 days of end date. Must not be a future date.
end_date	string	optional (default value is current date)	A valid date string must comply with regex:^\d{4}-\d{2}-\d{2}+(T)+\d{2}:\d{2}:\d{2}+(Z)$
start	integer	optional (default value is 0)	A valid integer number must comply with regex: [0-9]+. The start parameter is used to identify the starting point to return rows from a result set.
rows	integer	optional (default value is 50)	A valid integer indicating number of records to be returned. Must comply with regex: [0-9]+. The maximum value is 200.
sort	string	optional (default value is event_date:asc)	A valid string should be in the format FIELD_NAME:SORT_ORDER. Sort order can be ASC or DESC. The valid field names are user_agent, ip_address, event_type, user_id and event_date
event_type	string	optional (default value is blank)	A valid event type. Valid event types are recruiter_login, recruiter_logout, recruiter_signup

Errors

The Careers API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is invalid.
403	Forbidden -- Access to the API requested is restricted.
404	Not Found -- The specified API could not be found.
405	Method Not Allowed -- API access was attempted with an invalid method.
500	Internal Server Error -- We had a problem with our server. Please try again later.
503	Service Unavailable -- The API is temporarily offline for maintenance. Please try again later.