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=1660933

Retrieving data about job(s) is done through the GET method, using
https://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:

ParameterDescription
pagePage number. 1,000 jobs per page.
activeList active jobs (1) or inactive jobs (0). Defaults to 1.
jobIdSearch for a specific job ID.
minJobIdMinimum job ID — returns jobs with an ID equal to or higher.
serviceTypeIdRetrieve jobs connected only to a specific service type.

PARAMS

FieldExample valueRequired
key{{api_key}}yes
scopejobyes
fieldsname, startDate, endDate, monthSalary, positionPercentyes — at least 1 field, comma-separated
jobId1660933no
page1no
active0no

Job Fields (available in GET responses)

FieldTypeDescription
employmentIdstringConnected employment ID
responsibleUserIdstringResponsible user ID
collectiveAgreementIdstringCollective agreement ID
salaryMatrixCategoryIdstringSalary matrix category ID
namestringJob name
startDatestringJob start date
endDatestringJob end date
salarystringHour salary. Format: #####.##
invoicestringHour invoice. Format: #####.##
descriptionstringJob description
salaryTypestringSalary type. Valid values: hourSalary, daySalary, monthSalary, unitSalary, consultant
separateInvoicestringSeparate invoice. Valid values: 0, 1
holidayRatestringHoliday rate. Format: ##.##
socialCostPercentstringSocial cost percent value
onlineHourRegistrationstringOnline work registration permission.
0 = not allowed, 1 = allowed
createdstringJob creation date. Format: Y-m-d H:i:s
updatedstringJob update date. Format: Y-m-d H:i:s
projectNumberstringProject number
primarystringPrimary job value. 0 = not primary, 1 = primary
numberstringJob number
monthSalarystringMonth salary. Format: #####.##
monthInvoicestringMonth invoice. Format: #####.##
serviceTypeIdintegerService type connected to this job
positionPercentdecimalPosition 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

FieldTypeRequiredDescription
employmentIdstringyesEmployment ID for the candidate
projectIdintegeryesProject ID
candidateIdintegeryesCandidate ID
responsibleUserIdintegeryesResponsible user ID
namestringyesName
startDatestringyesStart date. Format "yyyy-mm-dd"
endDatestringyesEnd date. Format "yyyy-mm-dd"
salaryTypestringyesSalary type. Valid values: hourSalary, daySalary, monthSalary, unitSalary, consultant
invoiceintegernoInvoice
salarystringnoSalary. Format: #####.##
descriptionstringnoDescription
separateInvoicebooleannoSeparate invoice. Valid values: 0, 1
collectiveAgreementIdintegernoCollective agreement ID
serviceTypeIdintegernoService type ID connected to this job
positionPercentdecimalnoPosition 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.

FieldTypeRequiredDescription
jobIdintegeryesJob ID
employmentIdstringnoEmployment ID for the candidate
responsibleUserIdintegernoResponsible user ID
namestringnoName
startDatestringnoStart date. Format "yyyy-mm-dd"
endDatestringnoEnd date. Format "yyyy-mm-dd"
descriptionstringnoDescription
salaryTypestringnoSalary type. Valid values: hourSalary, daySalary, monthSalary, unitSalary, consultant
salarystringnoSalary. 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.

FieldTypeRequiredDescription
jobIdintegeryesJob ID of the job to delete

Retrieving Ended Jobs

GET

https://api.recman.io/v2/get/?key={{api_key}}&scope=endedJob&page=1&serviceTypeId=424

Retrieving the history of ended jobs is done through the GET method, using 
https://api.recman.io/v2/get/ with scope=endedJob.

PARAMS

FieldRequiredDescription
keyyesYour API key
scopeyesMust be endedJob
pageyesPage number; 1,000 records per page
minEndedJobIdnoMinimum ended-job ID to filter by
minJobIdnoMinimum job ID to filter by
serviceTypeIdnoFilter by a specific service type

Note

You can combine different search parameters to adjust your fetch requests more precisely.

Response fields

FieldDescription
endedIdID of the "ended job" record
jobIdID of the job that was ended
endedTimestamp of when the job was ended
endedUserIdID of the user who ended the job
commentsComments left when ending the job
reasonIdReason code for ending the job (see reason table below)
jobNested 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.

FieldTypeRequiredDescription
jobIdintegeryesID of the job to end
reasonIdintegeryesReason for ending the job (see table below)
endedUserIdintegeryesID of the user ending the job
commentsstringnoComment for ending the job (note: field name is spelled this way in the API)
ratingintegernoRating from 1–5. 0 or blank gives Undefined.
serviceTypeIdintegernoService type ID connected to the job

Reason ID values

reasonIdReason
1Job finished
2Trial period ended
3Buyout
4Fired
5Fired by customer
6Other
7Canceled by employee
8Canceled by customer

Note

On success, the response returns "success": true with no additional data.

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