SEEK - Australia's no. 1 jobs, employment, career and recruitment site

Apply on your site, with SEEK
Product Overview
API Overview
Integration Requirements
Walkthrough
API Methods
Milestones
Client On-boarding
Button
API MethodsThe following methods are available on the Apply on your site, with SEEK API:
POST Application PrefilledThis method retrieves a SEEK Application prefilled with Profile and Resume data, for a particular Job Ad. The Job Ad may or may not be listed on SEEK.For candidates in Asia with a SEEK profile:
  • ANZ market working rights will be available for prefill if the candidate has added them to their profile.
  • Asia market working rights will not be available for prefill.
  • Expected salary will not be available for prefill.
Request
POST https://api.seek.com.au/v2/applications/prefilledAccept: application/jsonAuthorization: Bearer <AuthCode access token>Content-Type: application/json{  "applicationFormUrl": "https://www.mycustomapplyform.com.au/jobs/123",  "advertiserId" : "1234567",  "positionTitle" : "Chief Executive Officer",  "positionUri" : "http://www.jobboard.biz/Job12345678",  "positionReference" : "Ext3453",  "countryCode" : "AU",  "postalCode" : "2001"}
Request parameters
advertiserIdBody param - Required
SEEK-allocated identifier for the advertiser, which enables the OAuth consent form to display their name (i.e. “ATS on behalf of Advertiser”). This can be a numeric SEEK advertiser ID or a forward-compatible SEEK API hirer OID.This should be supplied regardless of whether the given job ad is listed on or off SEEK. If a separate system posts your job ads please refer closely to Task: Retrieve a SEEK Application prefilled with SEEK Profile.
applicationFormUrlBody param - Required
Link-out URL. Used by SEEK to find the Job AdNote: when creating a Job Ad on SEEK that utilises _Apply on your site, with SEEK_ an Application Form URL must be entered. This parameter must be the exact same Application Form URL. Validation: must be a fully qualified URI. If a separate system posts your job ads please refer closely to Task: Retrieve a SEEK Application prefilled with SEEK Profile.
positionTitleBody param - Not required
The title of the open position as it appears in the job advertisement.
positionUriBody param - Not required
URI of the position – for detailed view.Validation: must be a fully qualified URI.
positionReferenceBody param - Not required
The reference of the open position as it appears in the job advertisement.
countryCodeBody param - Not required
Two alpha characters representing the country that the position is in.Validation: must be an “official assigned” or “exceptional reservation” code from ISO 3166-1 alpha-2.
postalCodeBody param - Not required
The postal code that the position is located.Validation: max 10 characters, alpha-numeric.
AuthenticationAn Authorize header is required with the following values:
  • Scheme: Bearer
  • Value: an Access Token obtained using the Authorization Code flow for the scope “r_profile_apply”
Responses fieldsThe return value is the full representation of the Application.
idint
A unique identifier for the application
createdstring
Datetime application was created
updatedstring
Datetime application was updated
applicantInfoobject
Information about the candidate applying for the job
firstNamestring
First name of the applicant
lastNamestring
Last name of the applicant
emailAddressstring
Email address of the applicant
phoneNumberstring
Email address of the applicant
availabilityobject
Information regarding the availability of the applicant
weeksint
Number of weeks for applicant to become available
currentLocationobject
Information on current location
idint
Identifier of location
descriptionstring
Descriptor of location
areasobject[]
Array of objects containing information about areas of the location
idint
Identifier of the area
descriptionstring
Descriptor of the area
skillsstring[]
Array of strings containing skills of the applicant
salaryAndVisaByCountryobject
Salary and visa information of the applicant. Contains a property per country
<countryId>object
Identifier of country. Contains visa salary details for country. Key is the country identifier as a string
descriptionstring
Description of country (e.g. “All of Australia”)
hasWorkingVisaboolean
Has working visa
minimumSalaryValuestring
Minimum salary
salaryTypestring
Descriptor of salary type
workHistoryobject[]
Array of objects containing the sections of an applicant's work history
jobTitlestring
Title of job
companyNamestring
Name of the company
industryobject
Industry information
idint
Identifier of industry
descriptionstring
Descriptor of industry
achievementsstring
Key achievements of role
fromstring
Datetime job started
tostring
Datetime job ended
resumeobject
Resume information for the applicant
linkstring
URI to the applicant's resume
completestring | undefined
URI to complete the specific application.If the candidate has previously applied to the job, this field will be undefined. In this scenario, your system does not need to call a URI upon application completion.
completedstring | undefined
Datetime that the application was first completed.If this is the first time that the candidate is applying to the job, this field will be undefined.
Sample responsesNew application (note the complete URI):
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
{
  "id": 123,
  "created": "2014-05-10T16:14:29",
  "updated": "2014-05-10T16:14:29",
  "applicantInfo": {
    "firstName": "Luke",
    "lastName": "Skywalker",
    "emailAddress": "luke@skywalker.net",
    "phoneNumber": "0412345678",
    "availability": {
      "weeks": 2
    },
    "currentLocation": {
      "id": 1234,
      "description": "Sydney",
      "areas": [
        {
          "id": 5678,
          "description": "CBD & Inner Suburbs"
        }
      ]
    },
    "skills": ["sword fighting", "jedi mind tricks"],
    "salaryAndVisaByCountry": {
      "3000": {
        "description": "All Australia",
        "hasWorkingVisa": true,
        "minimumSalaryValue": "85000",
        "salaryType": "Annual"
      },
      "3001": {
        "description": "All New Zealand",
        "hasWorkingVisa": false,
        "minimumSalaryValue": "50",
        "salaryType": "Hourly"
      }
    },
    "workHistory": [
      {
        "jobTitle": "jedi",
        "companyName": "rebel alliance",
        "industry": {
          "id": 7008,
          "description": "Information Technology, Media & Telecommunications"
        },
        "achievements": "rescued han solo",
        "from": "2013-05-01",
        "to": "2014-05-01"
      },
      {
        "jobTitle": "apprentice",
        "companyName": "rebel alliance",
        "industry": {
          "id": 7008,
          "description": "Information Technology, Media & Telecommunications"
        },
        "achievements": "destroyed death star",
        "from": "2012-05-01",
        "to": "2013-05-01"
      },
      {
        "jobTitle": "farmer",
        "companyName": "skywalkers",
        "industry": {
          "id": 7008,
          "description": "Information Technology, Media & Telecommunications"
        },
        "achievements": "droid maintenance",
        "from": "2011-05-01",
        "to": "2012-05-01"
      }
    ]
  },
  "resume": {
    "link": "https://api.seek.com.au/v2/resumes/999"
  },
  "complete": "https://api.seek.com.au/v2/Applications/123/complete"
}
Previously completed application (note the completed datetime):
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
{
  "id": 123,
  "created": "2014-05-10T16:14:29",
  "updated": "2014-05-11T12:00:00",
  "applicantInfo": {
    "firstName": "Luke",
    "lastName": "Skywalker",
    "emailAddress": "luke@skywalker.net",
    "phoneNumber": "0412345678",
    "availability": {
      "weeks": 2
    },
    "currentLocation": {
      "id": 1234,
      "description": "Sydney",
      "areas": [
        {
          "id": 5678,
          "description": "CBD & Inner Suburbs"
        }
      ]
    },
    "skills": ["sword fighting", "jedi mind tricks"],
    "salaryAndVisaByCountry": {
      "3000": {
        "description": "All Australia",
        "hasWorkingVisa": true,
        "minimumSalaryValue": "85000",
        "salaryType": "Annual"
      },
      "3001": {
        "description": "All New Zealand",
        "hasWorkingVisa": false,
        "minimumSalaryValue": "50",
        "salaryType": "Hourly"
      }
    },
    "workHistory": [
      {
        "jobTitle": "jedi",
        "companyName": "rebel alliance",
        "industry": {
          "id": 7008,
          "description": "Information Technology, Media & Telecommunications"
        },
        "achievements": "rescued han solo",
        "from": "2013-05-01",
        "to": "2014-05-01"
      },
      {
        "jobTitle": "apprentice",
        "companyName": "rebel alliance",
        "industry": {
          "id": 7008,
          "description": "Information Technology, Media & Telecommunications"
        },
        "achievements": "destroyed death star",
        "from": "2012-05-01",
        "to": "2013-05-01"
      },
      {
        "jobTitle": "farmer",
        "companyName": "skywalkers",
        "industry": {
          "id": 7008,
          "description": "Information Technology, Media & Telecommunications"
        },
        "achievements": "droid maintenance",
        "from": "2011-05-01",
        "to": "2012-05-01"
      }
    ]
  },
  "resume": {
    "link": "https://api.seek.com.au/v2/resumes/999"
  },
  "completed": "2014-05-10T16:20:00.123"
}
Reference dataA number of properties in the prefilled application response contain SEEK reference data.For details download the Expected Values spreadsheet.
SEEK.com.au
Contact us
Terms of use
Privacy
© SEEK Ltd.