Skip to main content
Send your API key in the X-Api-Key header on every request. Only GET /api/companies/{id} needs no key.
1

Create a key

In the dashboard, open Developers → API Keys and select Create key. Choose a Key type (Live or Sandbox), enter a Key name, and optionally set an Expiration date. The full key is shown only once, so store it right away.
2

Send it in the X-Api-Key header

There is no query-parameter or Authorization: Bearer form.
3

Call HTTPS

Plain HTTP gets a 301 redirect and never reaches the API. Most clients follow it by turning a POST into a GET and dropping the body, so call https:// directly.

Base URL

Every path in these docs is relative to this host, the only API host. The retired jobs-api.jobo.world no longer resolves, so update any configuration that still uses it. There is no staging host: the key picks the environment. For other ways to build without spending, see developing without spending.

Key format and scope

Both key types use the same shape and the same host. Secret scanners such as GitHub’s recognize both prefixes, so a leaked key gets flagged. A key belongs to your account. There are no teams or organizations, and keys have no scopes or per-endpoint permissions: you cannot create a search-only key. Rate limits and the wallet balance are per account, not per key.
You can hold at most 5 active keys, sandbox keys included. Creating a sixth returns 409 Conflict. All keys share your account’s rate limits, so extra keys separate environments but add no throughput.

The one endpoint that needs no key

GET /api/companies/{id} takes no key, costs nothing, is not rate limited, and is CDN-cached. That lets the company details_url on any job resolve from a browser or a public page without exposing a key.
Every other endpoint, including GET /api/companies/{id}/jobs, requires a key.

Rotating a key

1

Create the replacement

Several keys can be valid at once, so access has no gap.
2

Deploy it

Roll the new key out to every service.
3

Revoke the old one

Revoke it under Developers → API Keys once no traffic uses it.
At the 5-key limit you must revoke a key before you can create one, which breaks the overlap. Keep one slot free if you rotate on a schedule.
Revocation takes effect within about 30 seconds, because successful authentications are briefly cached. Treat a revoked key as live for that window. If a key is compromised, revoke it and email support@jobo.world.

Storing keys safely

Call the API only from your backend. A key in client-side code, a public repository, or a browser request is exposed to anyone who looks. Every call made with a leaked live key is billed to you.
  • Read keys from environment variables or a secrets manager, never from source.
  • Use one key per environment and per service, so you can revoke narrowly within the limit of 5.
  • Watch usage in the dashboard for unexpected spikes.

When authentication fails

A missing or unusable key returns 401 with one of these bodies:
The response also sets WWW-Authenticate: ApiKey realm="api.jobo.world". The realm is a label, not a host to call. A valid key whose included jobs and wallet balance cannot cover a request gets 402, not 403. See Errors for every envelope.
  • Send the key as an HTTP header named X-Api-Key, not as a query parameter.
  • Strip any trailing newline or space, a common result of reading the key from a file.
  • Check that the key is still active under Developers → API Keys.
  • Call https://connect.jobo.world, not the dashboard host (enterprise.jobo.world).
  • Some HTTP clients and proxies strip unknown custom headers. Check that X-Api-Key reaches the wire.
  • Use HTTPS: the HTTP redirect drops your request body.
  • After a rotation, confirm the deployed key is the new one.
You already have 5 active keys. Revoke one, or wait for one to expire, then try again.
Revoking affects only that key. Check which key your service actually loads: a stale environment variable or cached deployment config is the usual cause.