Welcome to the Neobrain v1 API documentation. This REST API allows secure interaction with Neobrain’s core data entities, including Users, Job Description, Job Offers and Additional Fields, enabling seamless integration into your applications.

​
Authentication

Neobrain v1 API uses Bearer API Token for secure access. You will need an API token to authorize your requests. All requests to the API must include an Authorization header with a Bearer API token: 
Authorization: Bearer {api-token}
Replace API-Token with the actual token provided.

​
API Overview

The API supports several data interactions, including managing Users, Jobs, and Job Offers. Each endpoint supports standard RESTful methods such as GET, POST, PATCH, and DELETE for interacting with resources. Below is a brief overview of the main entities :

​
Users

  • Manage user accounts in the system.
  • Retrieve, create, update, or delete users.

​
Job description

  • Interact with job descriptions and roles within the platform.
  • Access detailed information on different job titles and their requirements.

​
Job Offers

  • Publish and manage job offers.
  • Retrieve information about available job postings and their statuses.

​
Response Format

All responses from the API are returned in JSON format. Below is an example of a typical API response: 
{
  "name": "John Doe",
  "email": ""
}

​
Error Handling

The API uses standard HTTP status codes to indicate the success or failure of a request:
  • 200 OK: The request was successful.
  • 201 Created: The resource was successfully created.
  • 204 No Content: The request was successful, but there is no content to return.
  • 400 Bad Request: There was an error with the request.
  • 401 Unauthorized: Authentication failed or token is missing/invalid.
  • 403 Forbidden: The request is not allowed.
  • 404 Not Found: The requested resource was not found.
  • 409 Conflict: There was a conflict with the request.
  • 500 Internal Server Error: An error occurred on the server.
Error responses will also be in JSON format, providing additional information on what went wrong.

​
Rate Limits

To ensure optimal performance, Neobrain v1 API enforces rate limits. By default, requests are limited to 100 requests per minute. Exceeding this will result in a temporary ban.

​
Next Steps

Explore the endpoints and methods available for each data type in the following sections to start integrating Neobrain’s v1 API into your application!