This article covers the entity-specific endpoints available under the Other scope group.
Unlike the pure reference/lookup lists, these endpoints return structured data tied to specific records – tasks, child projects, job creation setup for a candidate/project pairing, and salary/addition/deduction/absence articles – plus a POST operation for accepting terms of service on behalf of a candidate.
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.