Recruit CRM API

https://docs.recruitcrm.io/docs/rcrm-api-reference/
Admin
Recruit CRM API is a REST-based API that enables developers to customize and manage recruitment data...
Tokens:3,544
Snippets:17
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### API Endpoints Overview

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjExMDcyMQ-authentication

Lists the available API versions and major resource categories.

```APIDOC
## API Endpoints

### Description
This section outlines the available API endpoints, organized by version and resource type.

### Versions
- **v1**

### Resources
- Candidates
- Contacts
- Companies
- Jobs
- Deals
- Tasks
- Meetings
- Notes
- Call Logs
- Hotlists
- Custom Fields
- Webhook Subscriptions
- Sequences
- Nested Custom Fields
- Lists
- List Off Limit Status
- Users
- Files
- Email
- Schemas
- Custom Field Search
```

--------------------------------

### Jobs API

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjMyNzk0NA-getting-started

Endpoints for managing job postings, allowing creation, retrieval, and updates.

```APIDOC
## Jobs API Endpoints

### Description
Provides functionalities to manage job postings.

### Method
GET, POST, PUT, DELETE

### Endpoint
/v1/jobs

### Parameters
#### Path Parameters
None

#### Query Parameters
- **status** (string) - Optional - Filter jobs by status.

#### Request Body
(Varies by method: e.g., for POST, includes job details)

### Request Example
(Example for POST request to create a job)
```json
{
  "title": "Software Engineer",
  "description": "Develop and maintain software."
}
```

### Response
#### Success Response (200)
- **jobs** (array) - A list of job objects.

#### Response Example
```json
{
  "jobs": [
    {
      "id": 101,
      "title": "Marketing Specialist",
      "status": "Open"
    }
  ]
}
```
```

--------------------------------

### Candidates API

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjMyNzk0NA-getting-started

Endpoints for managing candidates, including listing, creating, updating, deleting, and assigning them.

```APIDOC
## Candidates API Endpoints

### Description
Provides functionalities to interact with candidate data.

### Method
GET, POST, PUT, DELETE

### Endpoint
/v1/candidates

### Parameters
#### Path Parameters
None

#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **limit** (integer) - Optional - The number of results per page.

#### Request Body
(Varies by method: e.g., for POST, includes candidate details)

### Request Example
(Example for POST request to create a candidate)
```json
{
  "name": "John Doe",
  "email": "john.doe@example.com"
}
```

### Response
#### Success Response (200)
- **candidates** (array) - A list of candidate objects.
- **pagination** (object) - Pagination details.

#### Response Example
```json
{
  "candidates": [
    {
      "id": 1,
      "name": "Jane Smith",
      "email": "jane.smith@example.com"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 10,
    "totalItems": 100
  }
}
```
```

--------------------------------

### Base URL

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjMyNzk0NA-getting-started

The base URL for all API calls to Recruit CRM.

```APIDOC
## Base URL

### Description
All API calls are made using the following base URL.

### URL
`https://api.recruitcrm.io`

### Response Format
All responses return JSON.
```

--------------------------------

### Data Formatting

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/9033e3227d21f-recruit-crm-api

Guidelines for data formatting, including dates, times, and JSON payloads.

```APIDOC
## Dates and Time

All dates and time will be returned in the `ISO-8601 Date/Time Format` like `2020-06-29T05:36:22.000000Z`. Adjust accordingly in your application for the user's local timezone.

The Recruit CRM API accepts `JSON` payloads making it very easy to work with, all posted fields must follow the correct format otherwise this will result in the API returning an error message. Please see the different options available to you below.

**Note:** Whenever making API requests with GET method, please make sure that the query parameter values are URL encoded.
```

--------------------------------

### Authentication

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjExMDcyMQ-authentication

Details on how to authenticate API requests using an API Token and the required Authorization header format.

```APIDOC
## Authentication

### Description
To access the API, you need your API Token from Admin Settings. All API calls require an `Authorization` header.

### Method
All HTTP Methods (GET, POST, PUT, DELETE, etc.)

### Header
- **Authorization** (string) - Required - `Bearer <YOUR_API_TOKEN>`

### Getting Your API Token
1. Log in to Recruit CRM as an admin.
2. Navigate to Admin Settings.
3. Go to the API & Integrations Section.
4. Click 'Copy' next to your API Token.
```

--------------------------------

### Rate Limiting

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/d158c10843b7c-rate-limiting

Information about rate limiting policies, including limits based on account licenses and how to track usage via response headers.

```APIDOC
## Rate Limiting

### Description
Recruit CRM enforces rate limiting to ensure fair usage. The limits are dynamic, scaling with the number of licenses in your account. Accounts with 6 or fewer licenses have a limit of 60 requests per minute. Accounts with more than 6 licenses have a limit of 10 requests per minute per license. These limits apply per API Token.

If you exceed your limit, a 429 HTTP status will be returned. You can monitor your current usage and remaining calls using the `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers in the API response.

### Rate Limit Headers

- **X-RateLimit-Limit** (integer) - The total number of calls allowed per minute.
- **X-RateLimit-Remaining** (integer) - The number of calls remaining in the current rate limit window.

### Error Response

- **429 Too Many Requests** - Returned when the API rate limit is exceeded.
```

--------------------------------

### API Endpoints Overview

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/d158c10843b7c-rate-limiting

A list of available API endpoints for interacting with Recruit CRM data, including resources like Candidates, Contacts, Jobs, and more.

```APIDOC
## API Endpoints

### Description
This section provides an overview of the available API endpoints for managing various aspects of your Recruit CRM account.

### Available Endpoints

- **v1/Candidates**: Endpoints for managing candidate information.
- **v1/Contacts**: Endpoints for managing contact details.
- **v1/Companies**: Endpoints for managing company information.
- **v1/Jobs**: Endpoints for managing job postings.
- **v1/Deals**: Endpoints for managing sales deals.
- **v1/Tasks**: Endpoints for managing tasks.
- **v1/Meetings**: Endpoints for managing meetings.
- **v1/Notes**: Endpoints for managing notes.
- **v1/Call Logs**: Endpoints for logging calls.
- **v1/Hotlists**: Endpoints for managing hotlists.
- **v1/Custom Fields**: Endpoints for managing custom fields.
- **v1/Webhook Subscriptions**: Endpoints for managing webhook subscriptions.
- **v1/Sequences**: Endpoints for managing email sequences.
- **v1/Nested Custom Fields**: Endpoints for managing nested custom fields.
- **v1/Lists**: Endpoints for managing lists.
- **v1/List Off Limit Status**: Endpoint to check list off limit status.
- **v1/Users**: Endpoints for managing users.
- **v1/Files**: Endpoints for managing files.
- **v1/Email**: Endpoints for email operations.
- **v1/Schemas**: Endpoints for schema management.
- **v1/Custom Field Search**: Endpoints for searching custom fields with supported filter types.
```

--------------------------------

### Authentication

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/9033e3227d21f-recruit-crm-api

Information on how to authenticate your API requests using Bearer Token.

```APIDOC
## Security

### Bearer Auth
Provide your bearer token in the `Authorization` header when making requests to protected resources.

Example: `Authorization: Bearer 123`
```

--------------------------------

### API Base URL

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/9033e3227d21f-recruit-crm-api

The base URL for all API requests to Recruit CRM. Use the production URL for live integrations.

```APIDOC
## API Base URL

### Prod
`https://api.recruitcrm.io`

### Mock Server
`https://stoplight.io/mocks/recruitcrm/rcrm-api-reference/978024`
```

--------------------------------

### Status Codes

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/9033e3227d21f-recruit-crm-api

Summary of HTTP status codes used by the Recruit CRM API and their meanings.

```APIDOC
## Status Codes

Recruit CRM API uses conventional HTTP response codes to indicate the success or failure of an API request.

### HTTP status code summary

| **Status Code** | **Description** |
|---|---|
| **200 OK** | Everything worked as expected. |
| **201 Created** | Your request has been processed successfully and the record has been created. |
| **202 Accepted** | Your request is currently being processed. You can check again later to see the request has been processed. |
| **400 Bad Request** | Your request was malformed. |
| **403 Forbidden** | Your API Token is invalid, missing, or has exceeded its quota. |
| **404 Not Found** | This resource cannot be found. You will receive this status code if you attempt to query our deprecated endpoints. |
| **405 Method Not Allowed** | You have queried the API with an unsupported HTTP method. Retry your query with either `GET` or `POST`. |
| **422 Invalid** | Invalid or missing API query parameter. |
| **429 Too Many Requests** | Too many requests issued to the API. Rate limiting kicks in and blocks further requests. |
| **500 Internal Server Error** | There was an unexpected error on our server. If you see this please contact support@recruitcrm.io.
```

--------------------------------

### Error Types

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/9033e3227d21f-recruit-crm-api

Description of different error types that can be returned by the Recruit CRM API.

```APIDOC
## Error Types

| **Type** | **Description** |
|---|---|
| **api_connection_error** | Failure to connect to Recruit CRM API. |
| **api_error** | API errors cover any other type of problem (e.g., a temporary problem with Recruit CRM’s servers), and are extremely uncommon. |
| **authentication_error** | Failure to authenticate your identity in the request. |
| **token_not_active_error** | API token is not active, you must activate your token to use API. |
| **rate_limit_error** | Too many requests hit the API too quickly. |
| **invalid_request_error** | Invalid request errors arise when your request has invalid parameters. |
| **validation_error** | Errors triggered by our client-side libraries when failing to validate fields.
```

--------------------------------

### Custom Field Search Filter Types

Source: https://docs.recruitcrm.io/docs/rcrm-api-reference/ZG9jOjEyMzU5OTgw-custom-field-search

Provides a list of supported filter types for custom field searches, including their applicable field types and whether a filter value is required.

```APIDOC
## Custom Field Search Supported Filter Types

### Description
This section details the supported filter types for searching custom fields. It specifies the field types compatible with each filter and whether a filter value is mandatory.

### Method
GET (Implied, as this is a reference for filter types, not a specific endpoint)

### Endpoint
N/A (Reference information)

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response (Implied)
- **Filter Type** (string) - The name of the filter type.
- **Field Types** (array of strings) - The types of fields that support this filter.
- **Filter Value Required** (boolean) - Indicates if a value is required for this filter.

#### Response Example
```json
[
  {
    "Filter Type": "equals",
    "Field Types": ["text", "longtext", "number", "date", "dropdown", "multiselect", "email", "phonenumber"],
    "Filter Value Required": true
  },
  {
    "Filter Type": "not_equals",
    "Field Types": ["text", "longtext", "number", "date", "dropdown", "multiselect", "email", "phonenumber"],
    "Filter Value Required": true
  },
  {
    "Filter Type": "contains",
    "Field Types": ["text", "longtext", "email", "phonenumber"],
    "Filter Value Required": true
  },
  {
    "Filter Type": "not_contains",
    "Field Types": ["text", "longtext", "email", "phonenumber"],
    "Filter Value Required": true
  },
  {
    "Filter Type": "available",
    "Field Types": ["text", "longtext", "number", "date", "dropdown", "multiselect", "email", "phonenumber", "file"],
    "Filter Value Required": false
  },
  {
    "Filter Type": "not_available",
    "Field Types": ["text", "longtext", "number", "date", "dropdown", "multiselect", "email", "phonenumber", "file"],
    "Filter Value Required": false
  },
  {
    "Filter Type": "greater_than",
    "Field Types": ["number", "date"],
    "Filter Value Required": true
  },
  {
    "Filter Type": "less_than",
    "Field Types": ["number", "date"],
    "Filter Value Required": true
  },
  {
    "Filter Type": "yes",
    "Field Types": ["checkbox"],
    "Filter Value Required": false
  },
  {
    "Filter Type": "no",
    "Field Types": ["checkbox"],
    "Filter Value Required": false
  }
]
```
```
Tokens:
Raw