In this article, you can read about how to retrieve activity logs via the API, and how to create, update, and delete log entries using the log scope.
Retrieving Logs
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=log&minLogId=53865261&candidateId=5776144Retrieving logs is done through the GET method, using https://api.recman.io/v2/get/ with scope=log.
Note
When retrieving logs, you need to specify the ID of who you want to retrieve the log for. If you have a list of candidates (or companies, contacts, projects, users), you need to loop through them one by one – only one search segment can be used per request.
Search parameter (mandatory)
| Field | Description |
|---|---|
| minLogId required |
Lists logs from a certain point onward. |
Search segment (optional – choose one)
| Field | Description |
|---|---|
| companyId | Retrieve logs for a specific company. |
| companyContactId | Retrieve logs for a specific company contact. |
| candidateId | Retrieve logs for a specific candidate. |
| projectId | Retrieve logs for a specific project. |
| userId | Retrieve logs for a specific user. |
PARAMS
| Field | Example value | Required |
|---|---|---|
| key | {{api_key}} | yes |
| scope | log | yes |
| minLogId | 53865261 | yes |
| candidateId | 5776144 | yes (or another search segment) |
Response fields
| Field | Type | Description |
|---|---|---|
| logId | string | Log ID |
| typeId | integer | Log type ID |
| type | string | Log type name (see valid values table below) |
| text | string | Log text/description |
| created | date-time | Date and time the log was created |
| projectId | integer | Connected project ID (0 if none) |
| companyId | integer | Connected company ID |
| companyContactId | integer | Connected company contact ID |
| candidateId | integer | Connected candidate ID |
| userId | integer | ID of the user tied to the log entry |
Creating a Log
For inserting logs, use the POST method with https://api.recman.io/v2/post/,operation set to insert and scope set to log.
| Field | Type | Required | Description |
|---|---|---|---|
| candidateId | integer | no | Candidate ID to tie the log to. |
| companyId | integer | no | Company ID to tie the log to. |
| companyContactId | integer | no | Company contact ID to tie the log to. |
| projectId | integer | no | Project ID to tie the log to. |
| userId | integer | no | User ID to tie the log to. |
| created | date-time | no | Date and time of the log entry. Defaults to now if omitted. |
| text | string | no | Free-text description of the log entry. |
| type | string | no | Log type name (see valid values table below). |
Note
Although none of the entity fields are strictly required by the API, a log entry is only meaningful when tied to at least one entity (candidate, company, company contact, project, or user).
On success, the response returns affectedRows and the new logId.
Updating a Log
For updating logs, use the POST method with operation set to update and scope set to log. Only logId is required – include any other field you want to change.
| Field | Type | Required | Description |
|---|---|---|---|
| logId | integer | yes | ID of the log to update. |
| candidateId | integer | no | Candidate ID to tie the log to. |
| companyId | integer | no | Company ID to tie the log to. Can be changed via an update request. |
| companyContactId | integer | no | Company contact ID to tie the log to. |
| projectId | integer | no | Project ID to tie the log to. |
| userId | integer | no | User ID to tie the log to. |
| created | date-time | no | Date and time of the log entry. |
| text | string | no | Free-text description of the log entry. |
| type | string | no | Log type name (see valid values table below). |
On success, the response returns affectedRows count and a confirmation message.
Deleting a Log
For deleting a log, use the POST method with operation set to delete and scope set to log. Only logId is required.
| Field | Type | Required | Description |
|---|---|---|---|
| logId | integer | yes | ID of the log to delete. |
On success, the response returns affectedRows count and a confirmation message.
Valid Values for the "type" Field
The table below lists all valid values for the type field, used both in the GET response (alongside the typeId) and when creating or updating a log entry.
| addedPostalAddress addedToPipeline alert applicationConfirmationEmailed assignedPresentation backgroundcheck branchAdded branchDeleted callCanvas candidateAddedBranch candidateAddedCourseCertification candidateAddedEducation candidateAddedSkill candidateAddedWorkExperience candidateAppliedToJob candidateApprovedForStaffing candidateChangedPassword candidateCreated candidateDeleted candidateDeletedFile candidateEditedProfileInformation candidateEmail candidateFileUploaded candidateInterview candidateLanded candidateLoggedWork candidateLoginUpdated candidatePresentation candidateRemovedBranch candidateRemovedCourseCertification candidateRemovedEducation candidateRemovedFromPipeline candidateRemovedFromStaffing candidateRemovedSkill candidateRemovedWorkExperience candidateUploadedFile candidateUploadedProfilePicture christmasVisit coldCalling coldCallingAnswered coldCallingNoAnswer comment companyAddedContactPerson companyAddedToCallList companyCreated companyDeleted companyDeletedContactPerson companyFollowUp companyFollowUpCreated companyInformationUpdated companyLinkedToDepartment companyPortalClosed companyPortalOpened companyReactivated companyRelationCreated companyRelationDeleted companyUnlinkedFromDepartment companyUpdatedContactPerson companyUpdatedInformation companyUpdatedInvoiceAddress companyUpdatedPostalAddress companyUpdatedVisitAddress complaint contactPersonAdded contactPersonDeleted contactPersonLinkedToProject contactPersonUnlinkedToProject contactPersonUpdated coWorkerConnectedToCompany coWorkerCreated coWorkerInformationUpdated coWorkerLinkedToProject coWorkerRemovedFromCompany creditNoteCreated creditNoteEmailed creditNotePrinted creditNoteSentToFactoring creditRating crossSalesReceived crossSalesSent customerArrangement customerLunch customerSurvey customerVisit customerVisitExistingCustomer customerVisitNew cvSent demo departmentContactInformationUpdated departmentCreated departmentInformationUpdated departmentInvoiceInformationUpdated deviation documentCreated documentDeleted documentUpdated easterVisit economy editedJobEndDate emailSentToCustomer employeeConversation employeeInformationUpdated employeeMeeting existingTelephoneContacts extension fax feedback fileDeleted filesMovedToFolder fileUploaded |
fileUploadedToProject finnNoSettingsUpdated firstMeeting firstMeetingBooked folderCreated folderDeleted followUp followUpMeeting followUpMeetingBooked followUpNewSales followUpPhone information inPersonInterview intake interview interviewAtCustomer invoiceAddressAdded invoiceCreated invoiceEmailed invoiceInformationUpdated invoicePrinted invoiceSentToFactoring invoiceTaggedAsUnpaid jobApplicationDeclined jobCreated jobDeleted jobPostingChanged jobPostingDeleted jobPostingPublished jobPostingPublishedToFinnNo jobPostingRemoved jobUpdated letter linkedToProject loggedIn loggedOut logoUpdated meedUpdated meetBooked meetCalledOff meeting meetingBooked meetingWithNewCustomer multipleRepresentativeMeeting newCustomerMeeting newsletterSent newTelephoneContact offboarding onboarding orderCreated orderDeleted orderFollowUp orderingAndExtensionOfAssignment orderLineAdded orderLineDeleted orderLineUpdated orderUpdated phone phoneContact phoneInterview postalAddressUpdated presentation productCreated productDeleted productUpdated progressbarUpdated projectCreated projectFollowUp projectInformationUpdated projectStatusUpdated presentationOfAssignment receivedPayment reference rejectedToMeetAfterCall reminderCreated removedFromLanded residents salesEmail salesLetter salesMeeting skype smsSent subscriptionInformationUpdated summerVisit taggedAsViewed taskDelegated tipsSent travel travelPlan unableToReach unansweredCall updatedHomeScreen updatedWorkApproverLogin userDeleted userProfileUpdated userUpdatedPassword videoMeet videoMeetExistingCustomer videoMeetNewCustomer visitAddressAdded visitAddressUpdated weaViolation workApproved workApproverConnectedToJob workApproverCreated workApproverDeleted workApproverInformationUpdated workApproverRemovedFromJob workLogged workplaceVisit workUpdated |