Endpoints

This section aims at presenting all the base endpoints that are part of the SmartRecruiters public Posting API.

Available endpoints:

/postings – method for searching postings

/postings/{postingId} – method for getting details of posting

In an effort to make things consistent, we present each of these methods using the structure below:

Request – GET method to communicate to our API
Path Parameters – all of these are required
Query Parameters – all of these are optional
Response Body
Example http request
Example response

/postings

Description

Lists active postings published by given company.

Request

GET https://api.smartrecruiters.com/v1/companies/{companyIdentifier}/postings?q={query}&limit={limit}&offset={offset}&country={country}&region={region}&city={city}&department={department}&custom_field.{customFieldId}={customFieldValueId}&language={language}

Path Parameters

Name	Type	Description
companyIdentifier	string	The company id as it appears at the end of your default career site. To find have an administrator go to “Settings/Admin” and click on “Career Pages & Job Ads” and it will be what appears after the / in “https://careers.smartrecruiters.com/”

Query Parameters

You can find the full list of available query parameters under the API Reference tab.

Request Body

n/a

Response Body

ListResult containing list of Posting objects. However, some fields might not be set. To get full object use ‘ref’ property.

Example request

curl -i  https://api.smartrecruiters.com/v1/companies/smartrecruiters/postings?offset=10&q=developer

Example response

{
    "limit": 10,
    "offset": 0,
    "totalFound": 2,
    "content": [ 
    {
        "id": "74983486",
        "uuid": "34225731-e7cf-4584-b0b7-78098fe1a66b",
        "name": "test job",
        "jobAdId": "106f35bc-a0e6-4e55-96f9-56835e3f8349",
        "defaultJobAd": true,
        "company": {
            "identifier": "smartrecruiters",
            "name": "SmartRecruiters"
        },
        "releasedDate": "2011-12-19T15:28:46.493Z",
        "location": {
             "country": "US", 
             "region": "FL",
             "city": "Orlando",
             "remote": false
             "latitude": "28.557071",
             "longitude": "-81.359463" 
        },  
        "industry": {
            "id": "computer_software",
            "label": "Computer Software"
        },
        "department": {
            "id": 2323,            
            "label": "IT",
            "description": "IT Department"   
        },        
        "function": {
            "id": "engineering",
            "label": "Engineering"
        },
        "typeOfEmployment": {
            "id": "prop_toe_perm",
            "label": "Permanent"
        },
        "experienceLevel": {
            "id": "mid_senior_level",
            "label": "senior"
        },     
        "customField": [
            {
                "fieldId": "52d3c1b32c613b40c5797627",
                "fieldLabel": "Division",
                "valueId": "4b5716a0-9095-4caa-b583-3b03c8ded8c0",
                "valueLabel": "Sales EMEA"
            }
        ],
        "ref": "https://api.smartrecruiters.com/api-v1/companies/smartrecruiters/postings/74983486",
        "creator": {
            "name": "John Doe",
        }
    },
    {
        "id": "74790901",
        "uuid": "45425731-e7cf-4584-a0a7-78098fe1a58a",
        "name": "Account Manager",
        "company": {
            "identifier": "smartrecruiters",
            "name": "SmartRecruiters Inc"
        },
        "releasedDate": "2013-12-19T18:34:21.443Z",
        "location": {
            "city": "San Francisco",
            "region": "CA",
            "country": "us",
            "remote": true
        },
        "industry": {
            "id": "computer_software",
            "label": "Computer Software"       
        },
        "department": {
            "id": 2323,            
            "label": "Finance",
            "description": "Finance Department"
        },
        "function": {
            "id": "engineering",
            "label": "Engineering"
        },
        "typeOfEmployment": {
            "id": "toe_perm",
            "label": "Permanent"
        },
        "experienceLevel": {
            "id": "mid_senior_level",
            "label": "senior"
        },
        "customField": [
            {
                "fieldId": "52d3c1b32c613b40c5797627",
                "fieldLabel": "Division",
                "valueId": "32c87a5d-1365-4dc3-80fe-ecacfb0799c7",
                "valueLabel": "Marketing US"                
            }
        ],
        "ref": "https://api.smartrecruiters.com/api-v1/companies/smartrecruiters/postings/876737562",
        "creator": {
            "name": "John Doe"
        }
    }
]
}

Example requests (executable)

https://api.smartrecruiters.com/v1/companies/smartrecruiters/postings/
https://api.smartrecruiters.com/v1/companies/smartrecruiters/postings/?q=Front%20End
https://api.smartrecruiters.com/v1/companies/smartrecruiters/postings/?offset=2&limit=2
https://api.smartrecruiters.com/v1/companies/smartrecruiters/postings/?city=San%20Francisco

/postings/{postingId}