API Reference

SEO for Jobs APIs allow you to integrate Google for Jobs with ease and go beyond the basic job posting integration out of the box.

Register & request API token here: https://app.seo-for-jobs.com/register

The API root URL is https://app.seo-for-jobs.com/api/public. The API token for authentication can be requested within your SEO for Jobs account. An active plan is necessary to use the API. The token has to be sent via the additional header "x-api-token". The request limit is 50 requests per hour and can be increased on request.

GET /jobs

Get a list of all job postings within your account.

Parameters:

none

Response (Example):

{
list: [
{
id: "2fd59d17-14ea-4b86-a3d8-c3126db5fbc6",
title: "SAP S/4HANA Senior Developer",
description: "Lorem ipsum dolor sit amet
consetetur ..."
...
},
{...}
]
}

CURL (Example):

$curl - XGET - H 'x-api-key: cca265e6-5c40-4187-a0e9-713b4a9c453f' 'https://app.seo-for-jobs.com/api/public/jobs'

POST /job

Create a new job posting within your account.

Parameters:

  • status: One of this "DRAFT" or "PUBLISHED"

  • title: String

  • description: HTML description (allowed tags: br, ul, li)

  • employmentType: NULL or list of this "INTERN", "PERDIEM", "FULLTIME", "PARTTIME", "TEMPORARY", "VOLUNTEER", "CONTRACTOR" (eg.: ["FULLTIME", "PARTTIME"])

  • salaryCurrency: NULL or one of these "EUR", "CHF", "INR", "JPY", "USD"

  • salaryValue: Number (eg.: 42.00)

  • salaryUnit: NULL or one of these "DAY", "HOUR", "WEEK", "YEAR", "MONTH"

  • streetAndNo: String

  • city: String

  • postalCode: String (because of leading zeros)

  • countryCode: i18n country code (eg. "DE" or "FR").

  • companyName: String

  • companyLogoUrl: Full URL to a logo (250px x 250px, .png, .jpeg, .jpg)

  • redirectUrl: Full URL for redirecting after click on the "Apply Button" within Google for Jobs.

Response (Example):

{
id: "2fd59d17-14ea-4b86-a3d8-c3126db5fbc6"
status: "PUBLISHED",
title: "SAP S/4HANA Senior Developer",
description: "Lorem ipsum dolor sit amet
consetetur ..."
...
}

CURL (Example):

$curl - XPOST - H 'x-api-key: cca265e6-5c40-4187-a0e9-713b4a9c453f' - H "Content-type: application/json" - d '{status: "PUBLISHED",title: "SAP S/4HANA Senior Developer",description: "Lore Ipsum ...",employmentType: ["FULLTIME", "PARTTIME"],streetAndNo: "Jungfernstieg 47",city: "Hamburg",postalCode: "20354",countryCode: "DE",companyName: "SFJ",redirectUrl: "https://www.seo-for-jobs.com/de/jobs/sap-hana-senior-developer"}' 'https://app.seo-for-jobs.com/api/public/job'

PUT /job/{id}

Update an existing job posting with the corresponding {id}. Only submitted parameters will be updated. The update will be automatically pushed to Google in case the status is "PUBLISHED" after the update process.

Parameter:

  • status: One of these "DRAFT" or "PUBLISHED"

  • title: String

  • description: HTML description (allowed tags: br, ul, li)

  • employmentType: NULL or list of this "INTERN", "PERDIEM", "FULLTIME", "PARTTIME", "TEMPORARY", "VOLUNTEER", "CONTRACTOR" (eg.: ["FULLTIME", "PARTTIME"])

  • salaryCurrency: NULL or one of these "EUR", "CHF", "INR", "JPY", "USD"

  • salaryValue: Number (eg.: 42.00)

  • salaryUnit: NULL or one of these "DAY", "HOUR", "WEEK", "YEAR", "MONTH"

  • streetAndNo: String

  • city: String

  • postalCode: String (because of leading zeros)

  • countryCode: i18n country code (eg. "DE" or "FR").

  • companyName: String

  • companyLogoUrl: Full URL to a logo (250px x 250px, .png, .jpeg, .jpg)

  • redirectUrl: Full URL for redirecting after click on the "Apply Button" within Google for Jobs.

Response (Example):

{
id: "2fd59d17-14ea-4b86-a3d8-c3126db5fbc6",
status: "PUBLISHED",
title: "SAP S/4HANA Senior Developer",
description: "Lorem ipsum dolor sit amet
consetetur ..."
...
}

CURL (Example):

$curl - XPUT - H 'x-api-key: cca265e6-5c40-4187-a0e9-713b4a9c453f' - H "Content-type: application/json" - d '{title: "SAP S/4HANA Junior Developer",employmentType: ["FULLTIME"]}' 'https://app.seo-for-jobs.com/api/public/job/2fd59d17-14ea-4b86-a3d8-c3126db5fbc6'

DELETE /job/{id}

Delete a job posting with the corresponding {id}.

Parameter:

none

Response (Example):

{
status: "SUCCESS"
}

CURL (Example):

curl - XDELETE - H 'x-api-key: cca265e6-5c40-4187-a0e9-713b4a9c453f' 'https://app.seo-for-jobs.com/api/public/job/2fd59d17-14ea-4b86-a3d8-c3126db5fbc6'

Errors

In case an error occurred while processing your request you will get one of the following codes:

API_TOKEN_INVALID
The provided API Token was not found within an active account. An account is marked as "active" when it has an active plan.

REQUEST_LIMIT_REACHED
The daily request limit is reached. your request limit will be reset within a sliding 24h window.

UPGRADE_NECESSARY
The total count of jobs with the status "PUBLISHED" has reached your plan limit. Please upgrade your account to publish more jobs.

ID_NOT_FOUND
The provided ID for a specific job posting was not found.

Author: SEO for Jobs
Published at 01.10.2020
Modified at 18.03.2024
More articles …
Would you like to try out recruiting via Google? Create a free account now.

Free Consultation

We would be happy to provide you with advice and assistance to list your job ads at Google for Jobs!

Emma Williams
Google Jobs Expert
Get consulting now without obligation. We are happy to call you back - just send us a short message.
Request Callback
All data is transmitted encrypted.

That was successful

We will contact you at the latest If it is more urgent, we can be reached at +49 40 874 081 43 .

Register for free

Create a free account and get started on your job posting.

Emma Williams
Google Jobs Expert
Have questions? Call Us!
Start for free
All data is transmitted encrypted.

Check for free

Check to see if your job postings are ready for Google for Jobs within a few seconds.

Congratulations. You are already well prepared for Google for Jobs .
Chack now
All data is transmitted encrypted

Test result

Loading preview …
Show result
Reachability
A good start. Your job posting is good accessible with a loading time of seconds.
Reachability
Please check the link as it is not available.
Content readable
The basis has been created. The contents of the job posting are machine-readable.
Content readable
Since the link cannot be reached, we were unfortunately unable to check whether the content was legible.
Ready for Google for Jobs
Congratulations - the schema data for the job posting are available. This allows Google for Jobs to list the job posting
Ready for Google for Jobs
Your job ad is not yet ready for Google for Jobs. Prepare now
Ready for Google for Jobs
Since the link cannot be reached, we were unfortunately unable to check whether suitable schema data is available.
Job seekers available
A good start. Job postings for " " are actively searched for by prospective employees on Google for Jobs.
Publication possible
It is possible to publish job postings in the " " section.
Register now
Create your account and save 10% on all plans. Use the full potential of Google for Jobs. So nutzen Sie das Potential von Google for Jobs voll aus.
‹ back
All data is transmitted encrypted.
Create Free Employer profile
Create your employer profile now without obligation and free of charge.
Next