The Zenploy API allows third-parties to integrate with Zenploy by accessing customer data. This is especially useful if you want to build your own career page or already have one and want to integrate your jobs into it, by using this API you can make it automatically adjust whenever a change is made in Zenploy.
Our API follows the REST pattern and uses the JSON data format.
All paths in the documentation are relative to the base API url.
https://api.zenploy.io/v1
All API endpoints return one object or a list of objects upon success and the returned objects are wrapped in JSON in different ways depending on whether it is a list or not.
{
"object": {
"id": "wsakXxWcQal3naor",
...
}
}
{
"count": 2,
"objects": [{
"id": "IJ5rNNdu8QwRnfDQ",
...
}, {
"id": "MCFX35ePlLg5HWEM",
...
}]
}
There is no authentication required at the moment, all endpoints are read-only and public.
Whenever something goes wrong the API returns an appropriate HTTP status code (4xx or 5xx) along with an error message in the response body. All errors messages are formatted the same way and there is a defined list of error codes that we support.
{
"error": {
"code": code,
"message": message
}
}
Your request was not formatted correctly. Bad parameter, missing parameter, wrong data format, etc...
The requested resource is not accessible to you.
The requested resource is not available or does not exist.
The HTTP method used isn't supported for this endpoint.
Something unexpectedly went wrong on our side.
This object represents a company and contains descriptive information about it such as its name or the number of employees.
Unique identifier for the company.
Name of the company.
A range for the number of employees at the company.
A summary of what the company does.
Name of the associated industry.
URL for the company website.
Social media profile URLs, the possible keys are: linkedin, facebook and twitter.
Example
{
"id":"LP6kqmsorq1RbN2Q",
"name": "Zenploy",
"summary": "This is the summary of our awesome company.",
"industry": "Software",
"website": "https://www.zenploy.io",
"social": {
"twitter": null,
"linkedin": null,
"facebook": "https://www.facebook.com/zenploy"
},
"num_employees": {
"min": 1,
"max": 5
},
"logo": {
"id": "v7Uh5XbHxE98NNDJ",
"type": "image",
"public": true,
"preview": {
"ready": false,
"available": false
},
"file": {
"size": 5696,
"name": "logo.png"
},
"download_url": "https://www.zenploy.io/data/v7Uh5XbHxE98NNDJ"
}
}
This object represents a physical location.
Unique identifier for the location.
Name or label given to this location.
Associated postal address.
Street address.
City name.
Zip code.
State or region name (if applicable).
Country name.
Example
{
"id":"TTki4l7ljOco6L0H",
"name": "San Francisco Office",
"address": {
"street": "123 main st.",
"city": "San Francisco",
"state": "CA",
"zip_code": "94101",
"country": "United States"
}
}
This object represents a department within a company, such as "Engineering" or "Accounting".
Unique identifier for the department.
Name or label given to this department.
Example
{
"id": "p2ehitprbQe43pnX",
"name": "Engineering"
}
This object represents a job offer, it contains its description and attributes.
Unique identifier for the job.
Job title.
UNIX timestamp of the last update.
HTML-formatted job description.
Text-only job description.
HTML-formatted profile for this job.
Text-only profile for this job.
URL of the application form for this job, use it to collect candidate applications. e.g. https://jobs.zenploy.io/amce/5671dK8M8qWv5Tkj/apply
Optional attributes of the job.
Range of experience required, values can be one of: entry, junior, middle, senior or expert.
Type of contract that's offered, can be one of: fulltime, parttime, contract, internship, apprenticeship or interim.
Range of level of education required, values can be one of: highschool, undergraduate, graduate or postgraduate.
Describes the telecommute policy, can be one of: yes, no or possible.
Salary range offered.
Equity range offered, if any, expressed in percents.
Range of possible duration if it's a temporary position.
Description of when the job should start, e.g. Early June 2023 or ASAP.
Example
{
"id": "2jEdje53xAEzUK5t",
"title": "Senior Software Engineer",
"updated_at": 1559854197,
"description": "We're an awesome company, come be part of it!!",
"description_text": "We're an awesome company, come be part of it!!",
"profile": "We're looking for someone great.",
"profile_text": "We're looking for someone great.",
"apply_url": "https://jobs.zenploy.io/amce/5hjZvEXfrF0MEoDN/apply",
"location": {
"id":"TTki4l7ljOco6L0H",
"name": "SF Office",
"address": {
"street": "123 main st.",
"city": "San Francisco",
"state": "CA",
"zip_code": "94101",
"country": "United States"
}
},
"department": {
"id": "m7P0oaXl8FShlqat"
"name": "Engineering",
},
"attributes": {
"type": "fulltime",
"level": {
"min": "middle",
"max": "senior"
},
"education": {
"min": "graduate",
"max": null
},
"duration": null
"telecommute": "no",
"start_date": "2024-01-01",
"salary":{
"min": 5000,
"max": 10000,
"period": "monthly",
"currency": "$"
},
"equity": {
"min": 1,
"max": 2
}
}
}
This represents a file resource such as an image or a PDF document.
Unique identifier for the resource.
Data type associated with this resource, can be one of:
pdf, ms_doc, image, text, url or other.
Whether this resource is public or protected behind authentication.
Atributes of the associated file.
File name.
Size in bytes.
Information about the preview thumbnail.
Whether this resource can be previewed.
Whether the preview thumbnail is done being generated.
URL to retrive the preview thumbnail for this resource (if available and ready).
Download information.
Whether this resource can be downloaded.
URL to download the raw resource data (if available).
Example
{
"id": "v7Uh5XbHxE98NNDJ",
"type": "image",
"public": true,
"preview": {
"ready": false,
"available": false
},
"file": {
"size": 5696,
"name": "logo.png"
},
"download_url": "https://www.zenploy.io/data/v7Uh5XbHxE98NNDJ"
}
The name of the company you want to retrieve information about.
The name of the company you want to retrieve information about.
The name of the company you want to retrieve information about.
The id of the location to retrieve.
The name of the company you want to retrieve information about.
The name of the company you want to retrieve information about.
The id of the department to retrieve.
The name of the company you want to retrieve information about.
Id of the location to filter by.
Id of the department to filter by.
Experience level to filter by, can be one of:
entry, junior, middle, senior or expert.
Employment type to filter by, can be one of:
fulltime, parttime, contract, internship, apprenticeship or interim.
Education requirement to filter by, can be one of:
highschool, undergraduate, graduate or postgraduate.
Telecommute preference to filter by, can one of:
yes, no or possible.
curl -X GET "https://api.zenploy.io/v1/company/myCompanyName/jobs?filters[location]=ngZJgsXME2nUGENK&filters[level]=junior&filters[telecommute]=yes"
The name of the company you want to retrieve information about.
The id of the job to retrieve.
The id of the resource to retrieve.