This article explains how to use the API to search, create, update, and delete jobs, retrieve ended-job history and end active jobs.
Retrieving Jobs
GET
https://api.recman.io/v2/get/?key={{api_key}}&scope=job&fields=
name,startDate,endDate,monthSalary,positionPercent&jobId=1660933Retrieving data about job(s) is done through the GET method, usinghttps://api.recman.io/v2/get/ with scope=job.
By default, the parameter active is set to 1, which only lists active jobs. To list all jobs (active and inactive), add the parameter active=0.
Search parameters
You can combine any of the following parameters to narrow down your request:
| Parameter | Description |
|---|---|
| page | Page number. 1,000 jobs per page. |
| active | List active jobs (1) or inactive jobs (0). Defaults to 1. |
| jobId | Search for a specific job ID. |
| minJobId | Minimum job ID — returns jobs with an ID equal to or higher. |
| serviceTypeId | Retrieve jobs connected only to a specific service type. |
PARAMS
| Field | Example value | Required |
|---|---|---|
| key | {{api_key}} | yes |
| scope | job | yes |
| fields | name, startDate, endDate, monthSalary, positionPercent | yes — at least 1 field, comma-separated |
| jobId | 1660933 | no |
| page | 1 | no |
| active | 0 | no |
Job Fields (available in GET responses)
| Field | Type | Description |
|---|---|---|
| employmentId | string | Connected employment ID |
| responsibleUserId | string | Responsible user ID |
| collectiveAgreementId | string | Collective agreement ID |
| salaryMatrixCategoryId | string | Salary matrix category ID |
| name | string | Job name |
| startDate | string | Job start date |
| endDate | string | Job end date |
| salary | string | Hour salary. Format: #####.## |
| invoice | string | Hour invoice. Format: #####.## |
| description | string | Job description |
| salaryType | string | Salary type. Valid values: hourSalary, daySalary, monthSalary, unitSalary, consultant |
| separateInvoice | string | Separate invoice. Valid values: 0, 1 |
| holidayRate | string | Holiday rate. Format: ##.## |
| socialCostPercent | string | Social cost percent value |
| onlineHourRegistration | string | Online work registration permission. 0 = not allowed, 1 = allowed |
| created | string | Job creation date. Format: Y-m-d H:i:s |
| updated | string | Job update date. Format: Y-m-d H:i:s |
| projectNumber | string | Project number |
| primary | string | Primary job value. 0 = not primary, 1 = primary |
| number | string | Job number |
| monthSalary | string | Month salary. Format: #####.## |
| monthInvoice | string | Month invoice. Format: #####.## |
| serviceTypeId | integer | Service type connected to this job |
| positionPercent | decimal | Position percentage |
Creating a Job
POST
This API endpoint allows you to add jobs. This is for historical use only. You must create active jobs manually in RecMan. All jobs are added to projects, with a link to the candidate and the responsible user. Please note that candidates must be approved for staffing before you can add any jobs to them. For inserting jobs, use the POST method, operation set to insert and scope set to job.
Job Fields
| Field | Type | Required | Description |
|---|---|---|---|
| employmentId | string | yes | Employment ID for the candidate |
| projectId | integer | yes | Project ID |
| candidateId | integer | yes | Candidate ID |
| responsibleUserId | integer | yes | Responsible user ID |
| name | string | yes | Name |
| startDate | string | yes | Start date. Format "yyyy-mm-dd" |
| endDate | string | yes | End date. Format "yyyy-mm-dd" |
| salaryType | string | yes | Salary type. Valid values: hourSalary, daySalary, monthSalary, unitSalary, consultant |
| invoice | integer | no | Invoice |
| salary | string | no | Salary. Format: #####.## |
| description | string | no | Description |
| separateInvoice | boolean | no | Separate invoice. Valid values: 0, 1 |
| collectiveAgreementId | integer | no | Collective agreement ID |
| serviceTypeId | integer | no | Service type ID connected to this job |
| positionPercent | decimal | no | Position percentage in % |
On success, the response returns the new jobId, a confirmation message, and the number of affected rows.
Updating a Job
POST
For updating jobs, use the POST method with operation set to update and scope set to job. Only jobId is required — include any other field you want to change.
| Field | Type | Required | Description |
|---|---|---|---|
| jobId | integer | yes | Job ID |
| employmentId | string | no | Employment ID for the candidate |
| responsibleUserId | integer | no | Responsible user ID |
| name | string | no | Name |
| startDate | string | no | Start date. Format "yyyy-mm-dd" |
| endDate | string | no | End date. Format "yyyy-mm-dd" |
| description | string | no | Description |
| salaryType | string | no | Salary type. Valid values: hourSalary, daySalary, monthSalary, unitSalary, consultant |
| salary | string | no | Salary. Format: #####.## |
Deleting a Job
POST
To delete a job, use the POST method with operation set to delete and scope set to job. Only jobId is required.
| Field | Type | Required | Description |
|---|---|---|---|
| jobId | integer | yes | Job ID of the job to delete |
Retrieving Ended Jobs
GET
https://api.recman.io/v2/get/?key={{api_key}}&scope=endedJob&page=1&serviceTypeId=424Retrieving the history of ended jobs is done through the GET method, using https://api.recman.io/v2/get/ with scope=endedJob.
PARAMS
| Field | Required | Description |
|---|---|---|
| key | yes | Your API key |
| scope | yes | Must be endedJob |
| page | yes | Page number; 1,000 records per page |
| minEndedJobId | no | Minimum ended-job ID to filter by |
| minJobId | no | Minimum job ID to filter by |
| serviceTypeId | no | Filter by a specific service type |
Note
You can combine different search parameters to adjust your fetch requests more precisely.
Response fields
| Field | Description |
|---|---|
| endedId | ID of the "ended job" record |
| jobId | ID of the job that was ended |
| ended | Timestamp of when the job was ended |
| endedUserId | ID of the user who ended the job |
| comments | Comments left when ending the job |
| reasonId | Reason code for ending the job (see reason table below) |
| job | Nested object containing the full set of job fields for the ended job |
Ending a Job
To formally end an active job, use the POST method with https://api.recman.io/v2/post/, operation set to insert and scope set to endJob.
| Field | Type | Required | Description |
|---|---|---|---|
| jobId | integer | yes | ID of the job to end |
| reasonId | integer | yes | Reason for ending the job (see table below) |
| endedUserId | integer | yes | ID of the user ending the job |
| comments | string | no | Comment for ending the job (note: field name is spelled this way in the API) |
| rating | integer | no | Rating from 1–5. 0 or blank gives Undefined. |
| serviceTypeId | integer | no | Service type ID connected to the job |
Reason ID values
| reasonId | Reason |
|---|---|
| 1 | Job finished |
| 2 | Trial period ended |
| 3 | Buyout |
| 4 | Fired |
| 5 | Fired by customer |
| 6 | Other |
| 7 | Canceled by employee |
| 8 | Canceled by customer |
Note
On success, the response returns "success": true with no additional data.