L'API
This API is read-only and all requests require the "GET" HTTP method.
All requests require to pass your secret API access token. Please contact us if you are don't have one.
As your token is secret, it can not be publicly exposed, and the API should only be used server side.
For each API method, you will find the URL format, the possible query parameters and the response format.
The following type of entities are accessible:
Company
List
https://choosemycompany.com/api/company/
Return a list of companies corresponding to the passed parameters.
Optional Query Parameter | Description |
---|---|
max | Max number of returned results |
offset | Offset in the returned results |
size | Number of employees. Format "sizeMin-sizeMax" |
traineeProgramSize | Number of trainees per year. Format "sizeMin-sizeMax" |
companyLabel | Label. Format "label-period" |
sectorId | Sector id |
https://choosemycompany.com/api/company/?companyLabel=candidates+2015
):
{
"query":"companyLabel=candidates+2015",
"totalCount":"8",
"data":[
{"id":58100,"name":"Leroy Merlin","logo":"\/stock\/company-images\/logo_leroymerlin.jpg"},
{"id":77683,"name":"Sopra Steria","logo":"\/stock\/company-images\/sopra-1424859434.jpg"},
{"id":79553,"name":"L\u0027Or\u00e9al","logo":"\/stock\/company-images\/logo_loreal.jpg"},
{"id":73551,"name":"Deloitte","logo":"\/stock\/company-images\/happy_trainees_deloitte.png"},
{"id":79781,"name":"Technip","logo":"\/stock\/company-images\/technip.jpg"},
{"id":62458,"name":"Groupe Canal +","logo":"\/stock\/company-images\/groupe-canal-1448965556.jpg"},
{"id":100163,"name":"Dassault Syst\u00e8mes","logo":"\/stock\/company-images\/3DS_Logotype_RGB_BlueSteel.png"},
{"id":70008,"name":"Mazars","logo":"\/stock\/company-images\/mazars_male.jpg"}
]
}
Get
https://choosemycompany.com/api/company/{id}
Return info about the given company
Optional Query Parameter | Description |
---|---|
fields | Wanted set of fields. Can be "scores", "labels". If you want several sets at the same time, concatenate them with ",". |
https://choosemycompany.com/api/company/79781?fields=scores,labels
):
{
"query":"id=79781\u0026fields=scores,labels",
"data":{
"id":79781,
"name":"Technip",
"logoUrl":"\/stock\/company-images\/technip.jpg",
"headerImageUrl":"\/stock\/company-images\/headers\/2867.jpg",
"employeesScore":{
"score":3.33,
"participantsNum":48
},
"traineesScore":{
"score":4.12,
"participantsNum":138
},
"candidatesScore":{
"score":4.23,
"participantsNum":51
},
"labels":["trainees 2014-2015","candidates 2015","trainees 2015-2016"]
}
}
School
List
https://choosemycompany.com/api/school/
Documentation coming soon...
Get
https://choosemycompany.com/api/school/{id}
Documentation coming soon...
Forum
List
https://choosemycompany.com/api/forum/
Documentation coming soon...
Get
https://choosemycompany.com/api/forum/{id}
Documentation coming soon...
Service
List
https://choosemycompany.com/api/service/
Documentation coming soon...
Get
https://choosemycompany.com/api/service/{id}
Documentation coming soon...
Position
List
https://choosemycompany.com/api/position/
Documentation coming soon...
Get
https://choosemycompany.com/api/position/{id}
Documentation coming soon...
Experience
List
https://choosemycompany.com/api/experience/
Documentation coming soon...
Get
https://choosemycompany.com/api/experience/{id}
Documentation coming soon...
Sector
List
https://choosemycompany.com/api/sector/
Documentation coming soon...
Get
https://choosemycompany.com/api/sector/{id}
Documentation coming soon...
Region
List
https://choosemycompany.com/api/region/
Documentation coming soon...
Get
https://choosemycompany.com/api/region/{id}
Documentation coming soon...