In this article, you can learn how to retrieve reference lists and entity data from the Other scopes and accept the terms of service via the API.
Note
This article covers all scopes in the Other group. It begins with the reference lists you can retrieve, such as corporations, pipeline categories, branches, industries, tags, locations, occupations, employment groups, and user tags. It then covers the entity-specific endpoints, such as tasks, child projects, job creation setup, articles, and accepting the terms of service.
Get Corporations
Retrieve a list of all corporations in RecMan.
GET
https://api.recman.io/v2/get/?key={{api_key}}&scope=corporation&
fields=name,email,officePhone,updated,logo,pageParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to corporation |
| fields | string | Yes | Comma-separated list of fields to return. At least one field is required. |
Available Fields
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Corporation name |
| updated | string | No | Date/time of last update |
| string | No | Corporation email | |
| officePhone | string | No | Corporation office phone number |
| description | string | No | Corporation description |
| web | string | No | Corporation website |
| string | No | Corporation Facebook page | |
| string | No | Corporation LinkedIn page | |
| string | No | Corporation Twitter/X page | |
| page | integer | No | Corporation RecMan career page ID |
| logo | string | No | Link to the corporation logo |
Each corporation is returned with its corporationId, along with whichever fields you requested via the fields parameter.
Get Pipeline
Retrieve a list of candidate pipeline categories with their IDs. You will need these IDs to add a candidate to a specific pipeline stage.
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=candidatePipelineParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to candidatePipeline |
Each entry in the response contains a categoryId, the pipeline stage name (e.g., "Possible candidate", "1st interview", "Reference check"), and a corporationId (0 if the pipeline stage applies across all corporations).
Get Branch
Retrieve a list of branch categories and their underlying branches.
GET
https://api.recman.io/v2/get/?key={{api_key}}&scope=branchParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to branch |
The response is split into two lists: branchCategoryList, containing top-level categories (each with a branchCategoryId and name), and branchList, containing the individual branches nested under those categories.
Get Industries
Retrieve a list of industry categories and their underlying industries.
GET
https://api.recman.io/v2/get/?key={{api_key}}&scope=industryParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to industry |
Just like the Branch endpoint, the response is split into two lists: industryCategoryList, containing top-level categories (e.g., "Accounting/Finance/Insurance", "IT/Software Development"), and industryList, containing the individual industries nested under each category.
Get Tags
Retrieve a list of tags that can be applied to a company to reflect certain indicators.
GET
https://api.recman.io/v2/get/index.php?scope=tags&key={{api_key}}Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to tags |
Each tag is returned with a tagId, name, and corporationId (0 if the tag applies across all corporations).
Get Locations
Retrieve a list of countries, regions, and cities, each with a corresponding ID.
GET
https://api.recman.io/v2/get/?key={{api_key}}&scope=locationParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to location |
The response contains three separate lists – country, region, and city – each entry consisting of an ID field (e.g. countryId) and a name.
Get Occupation
Retrieve a list of occupations available in the system, with their corresponding details.
GET
https://api.recman.io/v2/get/?key={{api_key}}&scope=occupationParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to occupation |
Response Fields
| Field | Type | Required | Description |
|---|---|---|---|
| occupationCode | integer | No | ID of the specific occupation |
| name | string | No | Name of the specific occupation |
| lnr | integer | No | Occupation title |
| ynr | integer | No | Occupation field |
| code | integer | No | Occupation code, consisting of field + title |
This is a large, fixed reference list (thousands of rows) and does not support field selection or filtering – the full list is always returned.
Get Employment Group
Retrieve a list of all available employment groups with their names and IDs.
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=employmentGroupParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to employmentGroup |
The response contains a nested employmentGroup list, with each entry consisting of anemploymentGroupId and a name.
Get User Tags
Retrieve a list of all available user tags.
GET
https://api.recman.io/v2/get/index.php?key={{api_key}}&
scope=userTagListParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to userTagList |
Each user tag is returned with a userTagListId and a name.
Get Task
Retrieve a list of tasks with their corresponding details, 100 tasks per page.
GET
https://api.recman.io/v2/get/index.php?key={{api_key}}&
scope=task&page=1Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to task |
| page | integer | Yes | Page number of results to return. Each page contains up to 100 tasks. |
Response Fields
| Field | Type | Required | Description |
|---|---|---|---|
| taskId | integer | No | ID of the task |
| createUserId | integer | No | ID of the co-worker who created the task |
| created | string | No | Date/time the task was created |
| deadline | string | No | Task due date |
| description | string | No | Short description of the task |
| body | string | No | Full task body/notes |
| userId | integer | No | ID of the co-worker the task is assigned to |
| projectId | integer | No | ID of the linked project, if any |
| companyId | integer | No | ID of the linked company, if any |
| companyContactId | integer | No | ID of the linked contact person, if any |
| candidateId | integer | No | ID of the linked candidate, if any |
| completed | integer | No | Whether the task is completed (1) or not (0) |
| responsible | array | No | List of co-workers responsible for the task |
| followers | array | No | List of co-workers following the task |
| companies | array | No | List of companies linked to the task |
| projects | array | No | List of projects linked to the task |
| candidates | array | No | List of candidates linked to the task |
| companyContacts | array | No | List of contact persons linked to the task |
A task can be linked to any combination of a project, company, contact person, and candidate at once, and a single task can have multiple responsible co-workers and followers. To page through all tasks, keep incrementing the page parameter until an empty result is returned.
Get Child Project
Retrieve a list of child projects available in the system, with their corresponding details.
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=childProjectParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to childProject |
Response Fields
| Field | Type | Required | Description |
|---|---|---|---|
| childProjectId | integer | No | ID of the child project |
| name | string | No | Name of the child project |
| companyId | integer | No | ID of the company the child project is tied to |
| created | string | No | Date/time the child project was created |
| creditTime | string | No | Credit time setting for the child project |
| invoiceNotes | string | No | Notes to appear on invoices generated for the child project |
Results are returned in a nested childProject list. Recall that a child project is a subdivision of a parent project tied to a specific customer, used to separate logged work and invoicing into distinct buckets under the same company.
Get Job Creation Setup
Retrieve job setup details for a specific candidate and project combination, useful when preparing to create a new job for that candidate on that project.
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=jobSetup&candidateId=5776144&projectId=856623Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to jobSetup |
| candidateId | integer | Yes | ID of the candidate to retrieve job setup details for |
| projectId | integer | Yes | ID of the project to retrieve job setup details for |
Response Fields
| Field | Type | Required | Description |
|---|---|---|---|
| default | object | No | Default setup values, containing invoice, salary, salaryMatrixCategoryId, and collectiveAgreementId |
| salaryMatrix | array | No | List of available salary matrices that can be applied to the job |
| collectiveAgreement | array | No | List of available collective agreements that can be applied to the job |
| employment | array | No | List of available employments, each with an employmentId and name |
Use this endpoint before creating a job via the API, so that you can pick valid values for the salary matrix, collective agreement, and employment for that candidate/project pairing rather than guessing IDs.
Get Articles
Retrieve a list of all salary, addition, deduction, and absence articles, with their associated information.
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=articleParameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to article |
Response Fields
| Field | Type | Required | Description |
|---|---|---|---|
| articleId | integer | No | ID of the article |
| articleNumber | string | No | Primary article number |
| type | string | No | Article type. See Valid Values below. |
| socialCost | string | No | Social cost associated with the article |
| name | string | No | Name of the article |
| notes | string | No | Notes attached to the article |
| created | string | No | Date/time the article was created |
| updated | string | No | Date/time the article was last updated |
| secondaryArticleNumber | string | No | Secondary article number, if applicable |
Possible article types:
- salary
- addition
- deduction
- absence
Recall that these article types correspond to the four kinds of logged-work entries in RecMan: salary articles pay for regular work, addition and deduction articles adjust pay up or down, and absence articles record time an employee was not at work.
Accept Terms of Service
Accept the terms of service on behalf of a specific candidate.
POST
https://api.recman.io/v2/post/Body Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| key | string | Yes | Your API key |
| scope | string | Yes | Must be set to candidateAcceptTerms |
| operation | string | Yes | Must be set to insert |
| data | object | Yes | Object containing candidateId and userId. See fields below. |
data Object Fields
| Field | Type | Required | Description |
|---|---|---|---|
| candidateId | integer | Yes | ID of the candidate accepting the terms of service |
| userId | integer | Yes | ID of the co-worker registering the acceptance on the candidate's behalf |
On success, the operation confirms the acceptance was registered. Use this endpoint when a candidate's terms of service acceptance is being recorded through an external integration rather than through the candidate's own Career page action.