Authorization

All requests to the JobNimbus Platform API must be authenticated using an API key. Your API key is sent as a Bearer token in the Authorization header of every request.

Obtaining an API Key

1. Log in to your JobNimbus account.
2. Navigate to Settings > API Keys.
3. Click Create API Key and configure the desired access profile.
4. Copy your API key and store it in a secure location. The key will not be displayed again after you leave the page.

📘

Access profile permissions

Your API key inherits the permissions of the access profile it is assigned to. Only endpoints and actions permitted by that profile will be available.

Base URL

All Platform API requests use the following base URL:

https://api.jobnimbus.com

Authenticating Requests

Include the following headers with every API request:

Example Request

curl -X GET "https://api.jobnimbus.com/{service}/v1/{endpoint}" \
  -H "Authorization: Bearer {your_api_key}" \
  -H "Content-Type: application/json"

Replace {your_api_key} with the API key you generated in your JobNimbus settings.

Error Responses

If authentication or authorization fails, the API returns one of the following status codes:

Missing or invalid API key

401 response when missing Authorization header:

{
  "message": "Unauthorized"
}

403 response when API key is invalid, expired, or revoked:

{
  "message": "Forbidden"
}

Insufficient permissions

A valid API key that lacks permission for an action returns 403 Forbidden. The body follows the Problem Details format (application/problem+json).

Best Practices

• Keep your API key secret. Never expose it in client-side code, public repositories, or browser-accessible files.
• Use environment variables or a secrets manager to store your key rather than hard-coding it.
• Rotate keys periodically. Generate a new key and revoke the old one on a regular cadence.
• Apply least privilege. Assign the most restrictive access profile that still meets your integration needs.