API - Documentation / Job

Job

Job related methods

Get

Returns a specific job

https://api.itjobs.pt/job/get.json

Parameters

Parameter	Required	Description
api_key	Yes	Your unique identifier. You must request your API KEY. (string)
id	Yes	The requested job id (integer)

CURL example

$ curl --data "api_key=xxx&id=125378" https://api.itjobs.pt/job/get.json

Return values on success

{  
   "id":125378,
   "company":{  
      "id":2043,
      "name":"Bee Engineering - build together",
      "logo":"https:\/\/static.itjobs.pt\/images\/companies\/d7\/9c6\/2043\/logo.png",
      "description":"...",
      "phone":"213137691 ",
      "email":"[email protected]",
      "url":"http:\/\/www.bee-eng.pt",
      "slug":"bee-engineering-build-together"
   },
   "companyId":2043,
   "title":"Consultor Ruby on Rails",
   "body":"...",
   "ref":"",
   "salaryMin":11000,
   "salaryMax":17000,
   "types":[  
      {  
         "id":"1",
         "name":"Full Time"
      }
   ],
   "locations":[  
      {  
         "id":"14",
         "name":"Lisboa"
      }
   ],
   "country":"PT",
   "workModel":0,
   "publishedAt":"2015-06-23 10:28:33",
   "updatedAt":"2015-06-23 10:28:33",
   "slug":"consultor-ruby-on-rails"
}

Return values on error

{  
   "error":{  
      "message":"Job not found."
   }
}

List

Returns a list of jobs

https://api.itjobs.pt/job/list.json

Parameters

Parameter	Required	Description
api_key	Yes	Your unique identifier. You must request your API KEY. (string)
limit	No	Number of results (integer)
page	No	Page number (integer)
company	No	Filter results by company (comma separated integers)
type	No	Filter results by type (comma separated integers)
contract	No	Filter results by contract (comma separated integers)

CURL example

$ curl --data "api_key=xxx&limit=2" \
      https://api.itjobs.pt/job/list.json

Return values on success

{  
   "total":2449,
   "page":1,
   "limit":2,
   "results":[  
      {  
         "id":127166,
         "company":{  
            "id":2328,
            "name":"AskBlue",
            "logo":"https:\/\/static.itjobs.pt\/images\/companies\/fd\/69d\/2328\/logo.png",
            "description":"...",
            "address":"Av. Estados Unidos da Am\u00e9rica, 102 - 7\u00ba E\r\n1700-179 Lisboa",
            "phone":"+(351) 217 960 456",
            "email":"[email protected]",
            "url":"http:\/\/www.askblue.pt",
            "slug":"askblue"
         },
         "companyId":2328,
         "title":" Programador C# e PHP",
         "body":"...",
         "ref":" #5689409",
         "salaryMin":11000,
         "salaryMax":17000,
         "workModel":0,
         "types":[  
            {  
               "id":"1",
               "name":"Full Time"
            }
         ],
         "locations":[  
            {  
               "id":"14",
               "name":"Lisboa"
            }
         ],
         "publishedAt":"2015-07-06 13:37:20",
         "updatedAt":"2015-07-06 13:37:20",
         "slug":"programador-c-e-php"
      },
      {  
         "id":127163,
         "company":{  
            "id":457,
            "name":"BABEL - Sistemas de Informa\u00e7\u00e3o",
            "logo":"https:\/\/static.itjobs.pt\/images\/companies\/42\/998\/457\/logo.png",
            "description":"...",
            "address":"Av. da Rep\u00fablica, 90\/96, Galeria \u2013 Frac\u00e7\u00e3o 3",
            "phone":217615810,
            "fax":217615819,
            "email":"[email protected]",
            "url":"http:\/\/www.babel.es",
            "slug":"babel-sistemas-de-informacao"
         },
         "companyId":457,
         "title":"Consultor Especialista em Usabilidade",
         "body":"...",
         "ref":"BABELPT15_ITJUsuab",
         "salaryMin":11000,
         "salaryMax":17000,
         "workModel":0,
         "types":[  
            {  
               "id":"1",
               "name":"Full Time"
            }
         ],
         "locations":[  
            {  
               "id":"14",
               "name":"Lisboa"
            }
         ],
         "publishedAt":"2015-07-06 13:37:03",
         "updatedAt":"2015-07-06 13:37:03",
         "slug":"consultor-especialista-em-usabilidade"
      }
   ]
}

Search

Returns a list of jobs based on a query and filters

https://api.itjobs.pt/job/search.json

Parameters

Parameter	Required	Description
api_key	Yes	Your unique identifier. You must request your API KEY. (string)
q	Yes	Search query (comma separated strings)
limit	No	Number of results (integer)
page	No	Page numner (integer)
company	No	Filter results by company (comma separated integers)
type	No	Filter results by type (comma separated integers)
contract	No	Filter results by contract (comma separated integers)

CURL example

$ curl --data "api_key=xxx&q=java&limit=2" https://api.itjobs.pt/job/search.json

Return values on success

{  
   "total":686,
   "page":1,
   "limit":2,
   "query":"java",
   "results":[  
      {  
         "id":127117,
         "company":{  
            "id":519,
            "name":"Hays Information Technology",
            "logo":"http:\/\/static.itjobs.pt\/images\/companies\/63\/538\/519\/logo.png",
            "description":"...",
            "address":"Av. Rep\u00fablica, 90 - 1\u00ba Andar, Frac\u00e7\u00e3o 4\r\n1600-206 Lisboa\r\n",
            "phone":"21 782 6560",
            "fax":"22 607 8611",
            "email":"[email protected]",
            "url":"http:\/\/hays.pt\/it",
            "slug":"hays-information-technology"
         },
         "companyId":519,
         "title":"Programador",
         "body":"...",
         "ref":"",
         "salaryMin":11000,
         "salaryMax":17000,
         "types":[  
            {  
               "id":"1",
               "name":"Full Time"
            }
         ],
         "contracts":[  
            {  
               "id":"1",
               "name":"Contrato a termo"
            }
         ],
         "locations":[  
            {  
               "id":"14",
               "name":"Lisboa"
            }
         ],
         "publishedAt":"2015-07-06 12:17:18",
         "updatedAt":"2015-07-06 12:17:18",
         "slug":"programador-m-f"
      },
      {  
         "id":127103,
         "company":{  
            "id":1504,
            "name":"iCreate Consulting",
            "logo":"http:\/\/static.itjobs.pt\/images\/companies\/49\/b8b\/1504\/logo.png",
            "description":"...",
            "address":"Urbaniza\u00e7\u00e3o Alc\u00e2ntara Rio\r\nRua Fradesso da Silveira, N\u00ba8, 2\u00ba A\r\n1300-609 Lisboa\r\n",
            "phone":210337780,
            "fax":210337788,
            "email":"[email protected]",
            "url":"http:\/\/www.icreateconsulting.com",
            "slug":"icreate-consulting"
         },
         "companyId":1504,
         "title":"Oracle Java Developer ",
         "body":"...",
         "ref":"",
         "salaryMin":11000,
         "salaryMax":17000,
         "types":[  
            {  
               "id":"1",
               "name":"Full Time"
            }
         ],
         "locations":[  
            {  
               "id":"14",
               "name":"Lisboa"
            }
         ],
         "publishedAt":"2015-07-06 12:16:37",
         "updatedAt":"2015-07-06 12:16:38",
         "slug":"oracle-java-developer"
      }
   ]
}

Create

Creates a job ad on the site
This operation is reserved for companies registered/authorized on the site. Please refer to your own API KEYs.
This API call must use the HTTP POST method.

https://api.itjobs.pt/job/create.json

Parameters

Parameter	Required	Description
api_key	Yes	Your unique identifier. You must request your API KEY. (string)
title	Yes	Job title (string)
body	Yes	Job text (string)
location	No	Job location (comma separated integers)
contract	No	Job contract (comma separated integers)
type	No	Job type (comma separated integers)
work_model	No	Job work model: 0 (On-site), 1 (Remote), 2 (Hybrid). Defaults to 0 if omitted.
country	No	Job country (ISO 3166-1 alpha-2, e.g. PT, AO). Defaults to site country if omitted.
ref	No	Job reference (string)
salary_min	No	Minimum annual gross salary in EUR (integer, 5000 to 1000000; 0 or empty = no salary)
salary_max	No	Maximum annual gross salary in EUR (integer, 5000 to 1000000, not below salary_min; requires salary_min)
apply_method	No	How applications for this job should be collected: `platform` (through ITJobs - candidates apply on the site and you manage them from your dashboard), `url` (an external email or website, given via apply_address below), or `body` (a contact included directly in the job description). You never need to set this yourself: if apply_address is given it's inferred as `url`; otherwise it defaults to `body`. Only pass it explicitly if you want `platform`.
apply_address	No	Email address or URL where applications should be sent/redirected. Ignored when apply_method is `platform`.

The body parameter listed above should contain the text ad and can(should) use HTML to format it's layout.
The accepeted tags are 'p', 'strong', 'br', 'em', 'u', 'strike', 'ol', 'li', 'ul', 'a', 'b'. Tags attributes accepted are 'text-align'.
This API call must use the HTTP POST method.

Accounts on a free plan with no recent paid purchase can only collect applications through ITJobs: for these accounts apply_method is always platform regardless of what is submitted, and the job description may not contain an external email or website.

CURL example

$ curl --data "api_key=xxx&title=Developer&body=<p>Your content</p>&ref=ITJ&location=1" https://api.itjobs.pt/job/create.json

Return values on success

{  
   "success":{  
      "message":"Job created successfully. You can check status at \/job\/status or your company dashboard.",
      "id":"127176"
   }
}

Return values on error

{  
   "error":{  
      "message":"Not allowed. Please contact support."
   }
}

Edit

Edits a job ad on the site
This operation is reserved for companies registered on the site. Please refer to your own API KEYs

https://api.itjobs.pt/job/edit.json

Parameters

Parameter	Required	Description
api_key	Yes	Your unique identifier. You must request your API KEY. (string)
id	Yes	The job id (integer)
title	No	Job title (string)
body	No	Job text (string)
location	No	Job location (comma separated integers)
contract	No	Job contract (comma separated integers)
type	No	Job type (comma separated integers)
workModel	No	Job work model: 0 (On-site), 1 (Remote), 2 (Hybrid). Defaults to 0 if omitted.
country	No	Job country (ISO 3166-1 alpha-2, e.g. PT, AO). Defaults to site country if omitted.
ref	No	Job reference (string)
salary_min	No	Minimum annual gross salary in EUR (integer, 5000 to 1000000; 0 or empty = no salary)
salary_max	No	Maximum annual gross salary in EUR (integer, 5000 to 1000000, not below salary_min; requires salary_min)
apply_method	No	Same values as on Create (`platform`, `url`, `body`) - you never need to set this yourself. If omitted, existing values are left unchanged; for a job that has never had this set, it's inferred the same way as on creation.
apply_address	No	Email address or URL where applications should be sent/redirected. Ignored when apply_method is `platform`.

CURL example

$ curl --data "api_key=xxx&id=127176&title=Developer&body=<p>Your content</p>&ref=ITJ&location=1" https://api.itjobs.pt/job/edit.json

Return values on success

{  
   "success":{  
      "message":"Job edited successfully. You can check status at \/job\/status or your company dashboard",
      "id":"127176"
   }
}

Return values on error

{  
   "error":{  
      "message":"Not allowed. Please contact support."
   }
}

Status

Checks the status on a specific job ad
This operation is reserved for companies registered on the site. Please refer to your own API KEYs

https://api.itjobs.pt/job/status.json

Parameters

Parameter	Required	Description
api_key	Yes	Your unique identifier. You must request your API KEY. (string)
id	Yes	The job id (integer)

CURL example

$ curl --data "api_key=xxx&id=127176" https://api.itjobs.pt/job/status.json

Return values on success

{
    "success": {
        "status": {
            "id": "2",
            "name": "moderation"
        }
    }
}

Return values on error

{  
   "error":{  
      "message":"Job not found."
   }
}

Suspend

Suspends/removes a job ad on the site
This operation is reserved for companies registered on the site. Please refer to your own API KEYs

https://api.itjobs.pt/job/suspend.json

Parameters

Parameter	Required	Description
api_key	Yes	Your unique identifier. You must request your API KEY. (string)
id	Yes	The job id (integer)

CURL example

$ curl --data "api_key=xxx&id=127176" https://api.itjobs.pt/job/suspend.json

Return values on success

{  
   "success":{  
      "message":"Job suspeded successfully. You can check status at /job/status or your company dashboard.",
      "id":"127176"
   }
}

Return values on error

{  
   "error":{  
      "message":"Job not found."
   }
}

Appendix

Information regarding Job state, type, contract, location and work model

State

Id	Description
0	Removed
1	Active
2	Moderation
3	Suspended
4	Refused
5	Expired

Type

Id	Description
1	Full-time
2	Part-time

Contract

Id	Description
5	Estágio académico
4	Prestação de Serviços
3	Estágio profissional
2	Contrato sem termo
1	Contrato a termo

Work model

Id	Description
0	On-Site
1	Remote
2	Hybrid

Location

Id	Description
2	Açores
1	Aveiro
3	Beja
4	Braga
5	Bragança
6	Castelo Branco
8	Coimbra
10	Évora
9	Faro
11	Guarda
29	International
13	Leiria
14	Lisboa
15	Madeira
12	Portalegre
18	Porto
20	Santarém
17	Setúbal
22	Viana do Castelo
21	Vila Real
16	Viseu