๐Ÿ›‘

Assessment API Sunset

This API has been deprecated since September 4, 2023. The sunset date is May 10, 2024. If you are an assessment provider or looking to build an assessment integration with SmartRecruiters, please consider using the new Assessment API (2021).

insert

Description

Enables you to insert new offers. This operation requires passing an Offer object as part of a POST request.

Request

POST https://api.smartrecruiters.com/v1/offers

Path Parameters

n/a

Query Parameters

n/a

Request Body

Offer object needs to be passed as a part of the request body. Required fields are:

NameTypeDescription
catalogIdstringpartner specific identificator of an offer
namestringoffer name
descriptionstringshort offer description
termsobjectTerms object with price and category specified

Response Body

Instance of Offer

Example request

curl -i -H "X-SmartToken:abc123" -H "Content-Type: application/json;charset=utf-8" -d @body.json -X POST https://api.smartrecruiters.com/v1/offers

Example request body

{
    "catalogId": "ab-32-gf-asd",
    "name": "Java Developer Skill Test",
    "description": "Senior Java Developer Test",
    "terms": {
        "type": "SKILLS_TEST",
        "price": {
            "amount": "20.00",
            "currencyCode": "USD"
        }
    },
    "availability": {
        "expirationDate": "2013-02-26T09:32:02.528+0000",
        "industries": [
            {
                "id": "computer_software"
            },
            {
                "id": "internet"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "CA",
                "city": "San Francisco"
            }
        ]
    },
    "targetMarket": {
        "industries": [
            {
                "id": "computer_software"
            },
            {
                "id": "internet"
            }
        ],
        "functions": [
            {
                "id": "engineering"
            }, 
            {
                "id": "research"
            }
        ],
        "experienceLevels": [
            {                
                "id": "mid_senior_level"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "California",
                "city": "San Francisco"
            }
        ]
    }
}
Example response
{
    "id" : "511a3942300469a9c33819d8",
    "createDate": "2013-03-13T12:05:46.398+0000",
    "lastUpdateDate": "2013-03-13T12:05:46.398+0000",
    "catalogId": "ab-32-gf-asd",
    "name": "Java Developer Skill Test",
    "description": "Senior Java Developer Test",
    "status" : "INACTIVE",
    "terms": {
        "type": "SKILLS_TEST",
        "price": {
            "amount": "20.00",
            "currencyCode": "USD"
        }
    },
    "availability": {
        "expirationDate": "2013-02-26T09:32:02.528+0000",
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "CA",
                "city": "San Francisco"
            }
        ]
    },
    "targetMarket": {
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "functions": [
            {
                "id": "engineering",
                "label" : "Engineering"
            }, 
            {
                "id": "research",
                "label": "Research"
            }
        ],
        "experienceLevels": [
            {                
                "id": "mid_senior_level",
                "label": "Mid-Senior Level"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "California",
                "city": "San Francisco"
            }
        ]
    }
}

update

Description

Enables you to Update existing offers. This operation requires passing an offer id being changed and an Offer object as part of the POST request.

Request

POST https://api.smartrecruiters.com/v1/offers/{offerId}

Path Parameters

NameTypeDescription
offerIdstringunique id of an offer

Query Parameters

n/a

Request Body

Offer object needs to be passed as part of a request body. Required fields are:

NameTypeDescription
idstringExisting offer id
catalogIdstringPartner specific identificator of an offer
namestringOffer name
descriptionstringShort offer description
termsstringTerms object with price and category specified

Response

Updated instance of Offer

Example request

curl -i -H "X-SmartToken:abc123" -H "Content-Type: application/json;charset=utf-8" -d @body.json -X POST https://api.smartrecruiters.com/v1/offers/511a3942300469a9c33819d8

Example request body:

{
    "id" : "511a3942300469a9c33819d8",
    "catalogId": "ab-32-gf-asd",
    "name": "Java Developer Skill Test",
    "description": "Senior Java Developer Test",
    "terms": {
        "type": "SKILLS_TEST",
        "price": {
            "amount": "50.00",
            "currencyCode": "USD"
        }
    },
    "availability": {
        "expirationDate": "2013-02-26T09:32:02.528+0000",
        "industries": [
            {
                "id": "computer_software"
            },
            {
                "id": "internet"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "CA",
                "city": "San Francisco"
            }
        ]
    },
    "targetMarket": {
        "industries": [
            {
                "id": "computer_software"
            },
            {
                "id": "internet"
            }
        ],
        "functions": [
            {
                "id": "engineering"
            }, 
            {
                "id": "research"
            }
        ],
        "experienceLevels": [
            {                
                "id": "mid_senior_level"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "California",
                "city": "San Francisco"
            }
        ]
    }
}

Example response

{
    "id" : "511a3942300469a9c33819d8",
    "createDate": "2013-03-13T12:05:46.398+0000",
    "lastUpdateDate": "2013-03-13T12:05:46.398+0000",
    "catalogId": "ab-32-gf-asd",
    "name": "Java Developer Skill Test",
    "description": "Senior Java Developer Test",
    "status" : "INACTIVE",
    "terms": {
        "type": "SKILLS_TEST",
        "price": {
            "amount": "50.00",
            "currencyCode": "USD"
        }
    },
    "availability": {
        "expirationDate": "2013-02-26T09:32:02.528+0000",
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "CA",
                "city": "San Francisco"
            }
        ]
    },
    "targetMarket": {
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "functions": [
            {
                "id": "engineering",
                "label" : "Engineering"
            }, 
            {
                "id": "research",
                "label": "Research"
            }
        ],
        "experienceLevels": [
            {                
                "id": "mid_senior_level",
                "label": "Mid-Senior Level"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "California",
                "city": "San Francisco"
            }
        ]
    }
}

get

Description

Enables you to get offer details. This operation requires passing an offer id as part of the REQUEST parameter.

Request

GET https://api.smartrecruiters.com/v1/offers/{offerid}

Path Parameters

NameTypeDescription
offerIdstringunique id of an offer

Query Parameters

n/a

Request Body

n/a

Response Body

Instance of Offer

Example request

curl -i -H "X-SmartToken: abc123" -X GET https://api.smartrecruiters.com/v1/offers/511a3942300469a9c33819d8

Example response

{
    "id" : "511a3942300469a9c33819d8",
    "createDate": "2013-03-13T12:05:46.398+0000",
    "lastUpdateDate": "2013-03-13T12:05:46.398+0000",
    "catalogId": "ab-32-gf-asd",
    "name": "Java Developer Skill Test",
    "description": "Senior Java Developer Test",
    "status" : "INACTIVE",
    "terms": {
        "type": "SKILLS_TEST",
        "price": {
            "amount": "20.00",
            "currencyCode": "USD"
        }
    },
    "availability": {
        "expirationDate": "2013-02-26T09:32:02.528+0000",
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "CA",
                "city": "San Francisco"
            }
        ]
    },
    "targetMarket": {
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "functions": [
            {
                "id": "engineering",
                "label" : "Engineering"
            }, 
            {
                "id": "research",
                "label": "Research"
            }
        ],
        "experienceLevels": [
            {                
                "id": "mid_senior_level",
                "label": "Mid-Senior Level"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "California",
                "city": "San Francisco"
            }
        ]
    }
}

submit

Description

Enables you to submit an offer for review. This operation requires passing an offer ID as part of the REQUEST parameter.

Request

POST https://api.smartrecruiters.com/v1/offers/{offerid}/submit

Path Parameters

NameTypeDescription
offerIdstringunique id of an offer

Query Parameters

n/a

Request Body

n/a

Response Body

Instance of Offer

Example request

curl -i -H "X-SmartToken:abc123" -H "Content-Type: application/json;charset=utf-8" -X POST https://api.smartrecruiters.com/v1/offers/511a3942300469a9c33819d8/submit

Example response

{
    "id" : "511a3942300469a9c33819d8",
    "createDate": "2013-03-13T12:05:46.398+0000",
    "lastUpdateDate": "2013-03-13T12:05:46.398+0000",
    "catalogId": "ab-32-gf-asd",
    "name": "Java Developer Skill Test",
    "description": "Senior Java Developer Test",
    "status" : "UNDER_REVIEW",
    "terms": {
        "type": "SKILLS_TEST",
        "price": {
            "amount": "20.00",
            "currencyCode": "USD"
        }
    },
    "availability": {
        "expirationDate": "2013-02-26T09:32:02.528+0000",
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "CA",
                "city": "San Francisco"
            }
        ]
    },
    "targetMarket": {
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "functions": [
            {
                "id": "engineering",
                "label" : "Engineering"
            }, 
            {
                "id": "research",
                "label": "Research"
            }
        ],
        "experienceLevels": [
            {                
                "id": "mid_senior_level",
                "label": "Mid-Senior Level"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "California",
                "city": "San Francisco"
            }
        ]
    }
}

withdraw

Description

Enables you to withdrawing an offer from the marketplace. This operation requires passing an offer id as part of a REQUEST parameter. After a successful withdraw, the offer is not available in the marketplace anymore.

Request

POST https://api.smartrecruiters.com/v1/offers/{offerid}/withdraw

Path Parameters

NameTypeDescription
offerIdstringunique id of an offer

Query Parameters

n/a

Request Body

n/a

Response Body

Instance of Offer

Example request

curl -i -H "X-SmartToken:abc123" -H "Content-Type: application/json;charset=utf-8" -X POST https://api.smartrecruiters.com/v1/offers/511a3942300469a9c33819d8/withdraw

Example response

{
    "id" : "511a3942300469a9c33819d8",
    "createDate": "2013-03-13T12:05:46.398+0000",
    "lastUpdateDate": "2013-03-13T12:05:46.398+0000",
    "catalogId": "ab-32-gf-asd",
    "name": "Java Developer Skill Test",
    "description": "Senior Java Developer Test",
    "status" : "INACTIVE",
    "terms": {
        "type": "SKILLS_TEST",
        "price": {
            "amount": "20.00",
            "currencyCode": "USD"
        }
    },
    "availability": {
        "expirationDate": "2013-02-26T09:32:02.528+0000",
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "CA",
                "city": "San Francisco"
            }
        ]
    },
    "targetMarket": {
        "industries": [
            {
                "id": "computer_software",
                "label" : "Computer Software"
            },
            {
                "id": "internet",
                "label" : "Internet"
            }
        ],
        "functions": [
            {
                "id": "engineering",
                "label" : "Engineering"
            }, 
            {
                "id": "research",
                "label": "Research"
            }
        ],
        "experienceLevels": [
            {                
                "id": "mid_senior_level",
                "label": "Mid-Senior Level"
            }
        ],
        "locations": [
            {
                "country": "US",
                "region": "California",
                "city": "San Francisco"
            }
        ]
    }
}

list

Description

Enables you to get a list of existing offers. The number of offers returned as part of the list can be modified using the offset and limit parameters. These results will be sorted using lastUpdateDate.

Request

GET https://api.smartrecruiters.com/v1/offers?limit={limit}&offset={offset}&status={offerStatus}&q={queryString}

Path Parameters

n/a

Query Parameters

NameTypeDescription
limitintegernumber of offers to return. max number of offers returned by single call is 100
offsetintegernumber of offers to skip while processing result
statusstringoffer status. legal values are: INACTIVE, UNDER_REVIEW, ACTIVE, REJECTED
qstringfull text query. will match offers with name and description matching query string

Request Body

n/a

Response Body

ListResult containing list of Offers

Example request

curl -i -H "X-SmartToken: abc123" -X GET https://api.smartrecruiters.com/v1/offers?limit=10&offset=10&q=java

Example response

{
    "offset": 0,
    "limit": 10,
    "totalFound": 3,
    "content": [
        {
            "id": "511a3942300469a9c33819d8",
            "createDate": "2013-03-13T12:05:46.398+0000",
            "lastUpdateDate": "2013-03-13T12:05:46.398+0000",
            "catalogId": "ab-32-gf-asd",
            "name": "Java Developer Skill Test",
            "description": "Senior Java Developer Test",
            "status": "ACTIVE",
            "terms": {
                "type": "SKILLS_TEST",
                "price": {
                    "amount": "20.00",
                    "currencyCode": "USD"
                }
            }
        },
        {
            "id": "432a3942abc469a9c33819d8",
            "createDate": "2013-03-13T12:05:46.398+0000",
            "lastUpdateDate": "2013-03-13T12:05:46.398+0000",
            "catalogId": "df-55-gf-123",
            "name": "Java Architect Test",
            "description": "Java Architect Skill Test",
            "status": "ACTIVE",
            "terms": {
                "type": "SKILLS_TEST",
                "price": {
                    "value": "60.00",
                    "currencyCode": "USD"
                }
            }
        },
        {
            "id": "432a3942abc469a32c33549d8",
            "createDate": "2013-03-13T12:05:46.398+0000",
            "lastUpdateDate": "2013-03-13T12:05:46.398+0000",
            "catalogId": "df-55-12-bbb",
            "name": "Enterprise Java Beans Test",
            "description": "Enterprise Java Beans Test",
            "status": "UNDER_REVIEW",
            "terms": {
                "type": "SKILLS_TEST",
                "price": {
                    "amount": "40.00",
                    "currencyCode": "USD"
                }
            }
        } 
    ]
}