The API playground
Try the delivery, management and GraphQL APIs with your own jobs and candidates, see the JSON, and copy the request as curl or JavaScript.
How-to guide2 min read
The API playground runs Careers Orbit's APIs from your browser: the delivery and management APIs under REST, and GraphQL. Open it from Developers in the sidebar, or with API playground on API keys. It works like the playground in CMS Orbit and the other Orbit apps.
- Choose Add a public key at the top and paste a public key (
careers_pk_…) for the delivery API and GraphQL, a management token (careers_mt_…) for the management API, or both. Only hashes are stored in Careers Orbit, so it can't fill them in for you. They stay in this browser only. - Choose REST or GraphQL at the top left.
- With REST, choose an endpoint on the left, such as Published jobs or Applications, and fill in its parameters. Lists offer your own jobs, recent applications and candidates, such as the mountain guide job, so you never look up an id.
- Press Run, or ⌘ and Enter. The answer shows on the right with its status, time and size.
Choose a language at the top, such as de, and every request and query asks for it. Under the parameters, each endpoint describes what it returns, field by field.
GraphQL
With GraphQL, the left side shows the schema: every query, such as jobs or site, with its arguments and fields. Tick fields to add them to the query, or write the query yourself. The playground starts with a query for your career site. Add variables under Variables.
What runs here
Only readings run. Endpoints that apply, move, reject, tag, add notes or publish a job are described and marked with a lock, since they change real candidates and can send emails. Reading a candidate or an application's answers is recorded in the audit trail, as it is from a script.
Taking a request with you
Under the request, open curl or JavaScript to copy the same request for a terminal or your own code.
Was this page helpful?