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

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

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:

Header	Value	Required
`Authorization`	`Bearer {your_api_key}`	Yes
`Content-Type`	`application/json`	Yes, when sending a body

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:

Status Code	Meaning
`401 Unauthorized`	The request is missing an API key, or the provided key is invalid.
`403 Forbidden`	The API key is valid but lacks the required permissions for this action.

Error responses follow the Problem Details format:

{
  "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401
}

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.