A quick introduction to Neobrain v1 API
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.
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:
Replace API-Token
with the actual token provided.
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 :
All responses from the API are returned in JSON format. Below is an example of a typical API response:
The API uses standard HTTP status codes to indicate the success or failure of a request:
Error responses will also be in JSON format, providing additional information on what went wrong.
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.
Explore the endpoints and methods available for each data type in the following sections to start integrating Neobrain’s v1 API into your application!
A quick introduction to Neobrain v1 API
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.
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:
Replace API-Token
with the actual token provided.
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 :
All responses from the API are returned in JSON format. Below is an example of a typical API response:
The API uses standard HTTP status codes to indicate the success or failure of a request:
Error responses will also be in JSON format, providing additional information on what went wrong.
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.
Explore the endpoints and methods available for each data type in the following sections to start integrating Neobrain’s v1 API into your application!