Jobifyre API Documentation
Access job offers and candidate submissions through our powerful REST API.
Response Codes
Success Codes
The API returns standard HTTP success codes for successful requests:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Request succeeded. Response includes requested data. |
Error Codes
When errors occur, the API returns appropriate HTTP error codes:
| Code | Status | Description |
|---|---|---|
| 400 | Bad Request | Invalid request format or missing required parameters. |
| 401 | Unauthorized | Missing or invalid API key. |
| 403 | Forbidden | Valid API key but insufficient permissions. |
| 404 | Not Found | Requested resource does not exist. |
| 405 | Method Not Allowed | Requested method is not supported for the specified resource. |
| 500 | Internal Server Error | Server error. Contact support if persists. |
| 503 | Service Unavailable | Service temporarily unavailable. Retry later. |
Error Response Format
All error responses follow a consistent JSON format:
JSON Error Response
{
"success": false,
"status": 500,
"message": "An unexpected error occurred. Please contact support"
}
Error Handling Best Practices
Always Handle Errors: Implement proper error handling in your application to gracefully handle API errors and provide meaningful feedback to users.
- Check HTTP Status: Always check the HTTP status code first
- Parse Error Details: Read the error message and details for specific information
- Retry Logic: Implement exponential backoff for 500 and 503 errors
- Log Errors: Log API errors for debugging and monitoring
- User Feedback: Provide clear error messages to end users