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

name type description
limit integer number of offers to return. max number of offers returned by single call is 100
offset integer number of offers to skip while processing result
status string offer status. legal values are: INACTIVE, UNDER_REVIEW, ACTIVE, REJECTED
q string full 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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
{
    "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"
                }
            }
        } 
    ]
}