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,page

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust be set to corporation
fieldsstringYesComma-separated list of fields to return. At least one field is required.

Available Fields

FieldTypeRequiredDescription
namestringNoCorporation name
updatedstringNoDate/time of last update
emailstringNoCorporation email
officePhonestringNoCorporation office phone number
descriptionstringNoCorporation description
webstringNoCorporation website
facebookstringNoCorporation Facebook page
linkedinstringNoCorporation LinkedIn page
twitterstringNoCorporation Twitter/X page
pageintegerNoCorporation RecMan career page ID
logostringNoLink 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=candidatePipeline

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust 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=branch

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust 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=industry

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust 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

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust 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=location

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust 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=occupation

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust be set to occupation

Response Fields

FieldTypeRequiredDescription
occupationCodeintegerNoID of the specific occupation
namestringNoName of the specific occupation
lnrintegerNoOccupation title
ynrintegerNoOccupation field
codeintegerNoOccupation 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=employmentGroup

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust be set to employmentGroup

The response contains a nested employmentGroup list, with each entry consisting of an
employmentGroupId 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=userTagList

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust 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=1

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust be set to task
pageintegerYesPage number of results to return. Each page contains up to 100 tasks.

Response Fields

FieldTypeRequiredDescription
taskIdintegerNoID of the task
createUserIdintegerNoID of the co-worker who created the task
createdstringNoDate/time the task was created
deadlinestringNoTask due date
descriptionstringNoShort description of the task
bodystringNoFull task body/notes
userIdintegerNoID of the co-worker the task is assigned to
projectIdintegerNoID of the linked project, if any
companyIdintegerNoID of the linked company, if any
companyContactIdintegerNoID of the linked contact person, if any
candidateIdintegerNoID of the linked candidate, if any
completedintegerNoWhether the task is completed (1) or not (0)
responsiblearrayNoList of co-workers responsible for the task
followersarrayNoList of co-workers following the task
companiesarrayNoList of companies linked to the task
projectsarrayNoList of projects linked to the task
candidatesarrayNoList of candidates linked to the task
companyContactsarrayNoList 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=childProject

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust be set to childProject

Response Fields

FieldTypeRequiredDescription
childProjectIdintegerNoID of the child project
namestringNoName of the child project
companyIdintegerNoID of the company the child project is tied to
createdstringNoDate/time the child project was created
creditTimestringNoCredit time setting for the child project
invoiceNotesstringNoNotes 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=856623

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust be set to jobSetup
candidateIdintegerYesID of the candidate to retrieve job setup details for
projectIdintegerYesID of the project to retrieve job setup details for

Response Fields

FieldTypeRequiredDescription
defaultobjectNoDefault setup values, containing invoice, salary, salaryMatrixCategoryId, and collectiveAgreementId
salaryMatrixarrayNoList of available salary matrices that can be applied to the job
collectiveAgreementarrayNoList of available collective agreements that can be applied to the job
employmentarrayNoList 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=article

Parameters

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust be set to article

Response Fields

FieldTypeRequiredDescription
articleIdintegerNoID of the article
articleNumberstringNoPrimary article number
typestringNoArticle type. See Valid Values below.
socialCoststringNoSocial cost associated with the article
namestringNoName of the article
notesstringNoNotes attached to the article
createdstringNoDate/time the article was created
updatedstringNoDate/time the article was last updated
secondaryArticleNumberstringNoSecondary 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

FieldTypeRequiredDescription
keystringYesYour API key
scopestringYesMust be set to candidateAcceptTerms
operationstringYesMust be set to insert
dataobjectYesObject containing candidateId and userId. See fields below.

data Object Fields

FieldTypeRequiredDescription
candidateIdintegerYesID of the candidate accepting the terms of service
userIdintegerYesID 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.

Was this article helpful?
0 out of 0 found this helpful