SkyHive’s Jobs API lets you manage jobs and relevant job information. With this API, you can:
You can read, update, create, or delete job information using these methods:
A job ID is a required parameter when invoking the getJob, updateJob, and deleteJob methods. See below for more information.
Jobs are referenced by ID, which are created with createJob.
These use cases cover possible applications of the Jobs API:
Create a new Job object to add a new job to your organization.
Created
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
{- "details": {
- "referenceCode": "string",
- "title": "Software Engineer",
- "skillLevel": "experienced",
- "skills": [
- {
- "id": "5ab87a70c905f00a7145c59e",
- "title": "Software Development",
- "requirement": "required",
- "level": "experienced"
}
], - "type": "fulltime",
- "description": "string",
- "language": "en-US",
- "travel": "none"
}, - "country": {
- "twoLetterName": "US",
- "title": "United States of America",
- "currencyCode": "USD",
- "currencySymbol": "$"
}, - "locationTime": {
- "location": {
- "formattedAddress": "SkyHive, Cowper Street, Palo Alto, CA, USA",
- "addressLine1": "430 Cowper Street",
- "addressLine2": "Suite 250",
- "municipality": "Palo Alto",
- "postcode": "94301",
- "country": "US",
- "country3": "USA",
- "state": "California",
- "stateShort": "CA"
}, - "workType": "onsite",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "quantity": 1
}, - "compensation": {
- "type": "salary",
- "payRate": 1300,
- "maxPayRate": 2200,
- "currency": "USD",
- "duration": "hours",
- "hoursPerWeek": 48,
- "benefits": true,
- "relocate": "willingRelocate"
}, - "duties": "string",
- "qualification": "string",
- "sponsorship": false,
- "company": "SkyHive Technologies Inc.",
- "status": {
- "dateTime": "2019-08-24T14:15:22Z",
- "state": "published"
}, - "tags": [
- "string"
], - "sourceUri": "string",
- "entity": {
- "id": "string",
- "title": "string"
}, - "visibility": [
- "string"
]
}
Update the Job object to edit details (e.g. status, required skills, and compensation).
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
{- "details": {
- "referenceCode": "string",
- "title": "Software Engineer",
- "skillLevel": "experienced",
- "skills": [
- {
- "id": "5ab87a70c905f00a7145c59e",
- "title": "Software Development",
- "requirement": "required",
- "level": "experienced"
}
], - "type": "fulltime",
- "description": "string",
- "language": "en-US",
- "travel": "none"
}, - "country": {
- "twoLetterName": "US",
- "title": "United States of America",
- "currencyCode": "USD",
- "currencySymbol": "$"
}, - "locationTime": {
- "location": {
- "formattedAddress": "SkyHive, Cowper Street, Palo Alto, CA, USA",
- "addressLine1": "430 Cowper Street",
- "addressLine2": "Suite 250",
- "municipality": "Palo Alto",
- "postcode": "94301",
- "country": "US",
- "country3": "USA",
- "state": "California",
- "stateShort": "CA"
}, - "workType": "onsite",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "quantity": 1
}, - "compensation": {
- "type": "salary",
- "payRate": 1300,
- "maxPayRate": 2200,
- "currency": "USD",
- "duration": "hours",
- "hoursPerWeek": 48,
- "benefits": true,
- "relocate": "willingRelocate"
}, - "duties": "string",
- "qualification": "string",
- "sponsorship": false,
- "company": "SkyHive Technologies Inc.",
- "status": {
- "dateTime": "2019-08-24T14:15:22Z",
- "state": "published"
}, - "tags": [
- "string"
], - "sourceUri": "string",
- "entity": {
- "id": "string",
- "title": "string"
}, - "visibility": [
- "string"
]
}
patch the Job object to edit details (e.g. status, required skills, and compensation).
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
[- {
- "op": "add",
- "path": "string",
- "value": "string"
}
]
Get the Jobs object to view details (e.g. required skills, compensation, and location).
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
{- "ids": [
- "string"
]
}
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
{- "resultsPerPage": 10,
- "page": 0,
- "minMatchPercentage": 20,
- "includeExternal": false,
- "skills": [
- {
- "id": "5ab87a70c905f00a7145c59e",
- "title": "Software Development",
- "requirement": "required",
- "level": "experienced"
}
], - "country": "string",
- "currencyCode": "string",
- "duration": "hours",
- "jobIds": [
- "string"
], - "jobTitles": [
- "string"
], - "originalTitle": "string",
- "location": {
- "formattedAddress": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "municipality": "string",
- "postcode": "string",
- "country": "string",
- "country3": "string",
- "state": "string",
- "stateShort": "string",
- "locationHandle": "zlGRkTEdwMmUIDM3X9ymrS9wlGOyj/aNow57+P5j2L6qUe7sNI2cgS/SKmxHG/EYMCkmCq8b7s83pMVab6RTBC0pPS6oQSwLKCPln8HB1RuPmP+Q34y9yrHUiw08ZBe7pN7yKhI0IwI3vzwMXSqoaz+lMCfDNbRSniEOtifMEoYnIsIPYN/61+Hb4FzS7mP07+nrl1zfPuDI+lWttxziBhGAbbT30jlMbQ1o2hAMGLJYhl0jTrb6YsL6O7IALkrI3BX4vDOKbiLD2NZIhkSKWM3+RPTMruVxr9A4oNrTzTtZj/ftHU4grr5Nh1lDPBa0+1e9aRZuu9CqP/QTu6K6gg==",
- "radius": 20,
- "longitude": 0,
- "latitude": 0
}, - "fromPostedDate": "2019-08-24T14:15:22Z",
- "toPostedDate": "2019-08-24T14:15:22Z",
- "sortBy": "quality",
- "config": {
- "title": true,
- "location": true,
- "skills": true,
- "tags": true,
- "visibility": true,
- "nullOrEmptySkills": true,
- "algorithm": "default",
- "expiryDate": true,
- "sponsorship": true,
- "qualityParams": {
- "location": false,
- "relatedSkills": false,
- "reverseCalculation": false
}
}, - "companyNames": [
- "string"
], - "exclusions": {
- "companyNames": [
- "string"
]
}, - "sponsorshipCountries": [
- "string"
], - "payRate": 0,
- "maxPayRate": 0,
- "function": "string",
- "type": "fulltime",
- "types": "fulltime",
- "payType": "none",
- "workType": "remote",
- "workTypes": "remote",
- "travel": "none",
- "state": "cancelled",
- "visibility": [
- "string"
], - "tags": [
- "string"
]
}
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
{- "resultsPerPage": 10,
- "page": 0,
- "skills": [
- {
- "id": "5ab87a70c905f00a7145c59e",
- "title": "Software Development",
- "requirement": "required",
- "level": "experienced"
}
], - "country": "string",
- "currencyCode": "string",
- "duration": "hours",
- "jobIds": [
- "string"
], - "jobTitles": [
- "string"
], - "originalTitle": "string",
- "location": {
- "formattedAddress": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "municipality": "string",
- "postcode": "string",
- "country": "string",
- "country3": "string",
- "state": "string",
- "stateShort": "string",
- "locationHandle": "zlGRkTEdwMmUIDM3X9ymrS9wlGOyj/aNow57+P5j2L6qUe7sNI2cgS/SKmxHG/EYMCkmCq8b7s83pMVab6RTBC0pPS6oQSwLKCPln8HB1RuPmP+Q34y9yrHUiw08ZBe7pN7yKhI0IwI3vzwMXSqoaz+lMCfDNbRSniEOtifMEoYnIsIPYN/61+Hb4FzS7mP07+nrl1zfPuDI+lWttxziBhGAbbT30jlMbQ1o2hAMGLJYhl0jTrb6YsL6O7IALkrI3BX4vDOKbiLD2NZIhkSKWM3+RPTMruVxr9A4oNrTzTtZj/ftHU4grr5Nh1lDPBa0+1e9aRZuu9CqP/QTu6K6gg==",
- "radius": 20,
- "longitude": 0,
- "latitude": 0
}, - "fromPostedDate": "2019-08-24T14:15:22Z",
- "sortBy": "quality",
- "config": {
- "title": true,
- "location": true,
- "skills": true,
- "tags": true,
- "visibility": true,
- "nullOrEmptySkills": true,
- "algorithm": "default",
- "expiryDate": true,
- "sponsorship": true,
- "qualityParams": {
- "location": false,
- "relatedSkills": false,
- "reverseCalculation": false
}
}, - "includeExternal": false,
- "companyNames": [
- "string"
], - "exclusions": {
- "companyNames": [
- "string"
]
}, - "minMatchPercentage": 20,
- "sponsorshipCountries": [
- "string"
], - "payRate": 0,
- "maxPayRate": 0,
- "function": "string"
}
{- "total": 0,
- "values": [
- {
- "id": "string",
- "country": {
- "twoLetterName": "US",
- "title": "United States of America",
- "currencyCode": "USD",
- "currencySymbol": "$",
- "id": "string"
}, - "details": {
- "referenceCode": "string",
- "title": "Software Engineer",
- "skillLevel": "experienced",
- "skills": [
- {
- "id": "5ab87a70c905f00a7145c59e",
- "title": "Software Development",
- "sortOrder": 0,
- "definition": "string",
- "internal": true,
- "requirement": "required",
- "level": "experienced",
- "weight": 1,
- "type": "technical"
}
], - "type": "fulltime",
- "description": "string",
- "language": "en-US",
- "travel": "none",
- "confidential": true
}, - "locationTime": {
- "location": {
- "formattedAddress": "SkyHive, Cowper Street, Palo Alto, CA, USA",
- "addressLine1": "430 Cowper Street",
- "addressLine2": "Suite 250",
- "municipality": "Palo Alto",
- "postcode": "94301",
- "country": "US",
- "country3": "USA",
- "state": "California",
- "stateShort": "CA",
- "locationHandle": "string"
}, - "workType": "onsite",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "quantity": 1,
- "startHour": 0
}, - "compensation": {
- "type": "salary",
- "payRate": 1300,
- "maxPayRate": 2200,
- "currency": "USD",
- "duration": "hours",
- "hoursPerWeek": 48,
- "benefits": true,
- "relocate": "willingRelocate",
- "quantity": 0,
- "hidden": true
}, - "duties": "string",
- "qualification": "string",
- "sponsorship": false,
- "company": "string",
- "status": {
- "dateTime": "2019-08-24T14:15:22Z",
- "state": "published"
}, - "tags": [
- "string"
], - "sourceUri": "string",
- "entity": {
- "id": "string",
- "title": "string"
}, - "enterpriseId": "string",
- "function": "string",
- "metadata": {
- "empty": true,
- "property1": "string",
- "property2": "string"
}, - "visibility": [
- "string"
], - "originalId": "string",
- "referenceId": "string",
- "source": "string",
- "originalTitle": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "quality": 0,
- "desiredQuality": 0,
- "breakdown": {
- "skillRelevance": 0,
- "distance": 0,
- "relatedSkills": 0
}
}
]
}
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
{- "resultsPerPage": 10,
- "page": 0,
- "minMatchPercentage": 20,
- "includeExternal": false,
- "skills": [
- {
- "id": "5ab87a70c905f00a7145c59e",
- "title": "Software Development",
- "requirement": "required",
- "level": "experienced"
}
], - "country": "string",
- "currencyCode": "string",
- "duration": "hours",
- "jobIds": [
- "string"
], - "jobTitles": [
- "string"
], - "originalTitle": "string",
- "location": {
- "formattedAddress": "string",
- "addressLine1": "string",
- "addressLine2": "string",
- "municipality": "string",
- "postcode": "string",
- "country": "string",
- "country3": "string",
- "state": "string",
- "stateShort": "string",
- "locationHandle": "zlGRkTEdwMmUIDM3X9ymrS9wlGOyj/aNow57+P5j2L6qUe7sNI2cgS/SKmxHG/EYMCkmCq8b7s83pMVab6RTBC0pPS6oQSwLKCPln8HB1RuPmP+Q34y9yrHUiw08ZBe7pN7yKhI0IwI3vzwMXSqoaz+lMCfDNbRSniEOtifMEoYnIsIPYN/61+Hb4FzS7mP07+nrl1zfPuDI+lWttxziBhGAbbT30jlMbQ1o2hAMGLJYhl0jTrb6YsL6O7IALkrI3BX4vDOKbiLD2NZIhkSKWM3+RPTMruVxr9A4oNrTzTtZj/ftHU4grr5Nh1lDPBa0+1e9aRZuu9CqP/QTu6K6gg==",
- "radius": 20,
- "longitude": 0,
- "latitude": 0
}, - "fromPostedDate": "2019-08-24T14:15:22Z",
- "toPostedDate": "2019-08-24T14:15:22Z",
- "sortBy": "quality",
- "config": {
- "title": true,
- "location": true,
- "skills": true,
- "tags": true,
- "visibility": true,
- "nullOrEmptySkills": true,
- "algorithm": "default",
- "expiryDate": true,
- "sponsorship": true,
- "qualityParams": {
- "location": false,
- "relatedSkills": false,
- "reverseCalculation": false
}
}, - "companyNames": [
- "string"
], - "exclusions": {
- "companyNames": [
- "string"
]
}, - "sponsorshipCountries": [
- "string"
], - "payRate": 0,
- "maxPayRate": 0,
- "function": "string",
- "includeInternal": false,
- "source": [
- "string"
], - "sourcesEnum": [
- "linkedin"
]
}
OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
{- "data": {
- "clusteredTitle": "string",
- "language": "string",
- "sampleSize": 0,
- "title": "string",
- "records": [
- {
- "id": "string",
- "clusteredTitle": "string",
- "html": "string",
- "language": "string",
- "sampleSize": "string",
- "title": "string"
}
]
}, - "statusCode": 0
}