This article explains how to find the information you need in the RecMan API documentation.
All RecMan API documentation is located in this Help Center category – For developers.
Getting started with the API
If you are new to the RecMan API, begin with the articles in the section Getting started with API. They cover the basics that apply to every request: how to get your API key, how responses are cached, how to keep your integration secure, how deleting data works through the API, and the formats and conventions shared across all scopes.
Core Entities (Scopes)
Everything you need to retrieve and modify data in your RecMan account is found in the Core Entities (Scopes) section. Each API request targets a scope, which is the entity you want to work with, for instance candidate, company or project. You set the scope in the scope field of your request.
There is one article, or a small group of articles, for each scope. Use the section's article list to find the entity you want to work with.
How the scope articles are structured
Every scope article is a complete reference for that entity. It lists:
- the operations available for the scope (for example, retrieve, insert, update and delete)
- the endpoint to use for each operation
- the parameters (fields) you can send, including the type, whether each field is required, and a short description
- the fields returned in the response, where applicable
Required fields are clearly marked in each parameter table, so you can see what a request must contain before you send it. Where it helps, the description also explains which format to use or where to find the value, such as an ID.
If a field is an object (a field with subfields), the article describes the field and each subfield in a separate table below the main parameter list.
Note
Some entities are covered by more than one article; for example, one article covers retrieving data, and another covers creating or updating data. Check the full article list in the section if you cannot find the operation you are looking for.