Terminologies
-
New: APIs that have been added and available in the release
-
Updated: APIs/fields that have been updated and available in the release
-
Deprecated: APIs/fields that have been deprecated in the release will continue to work until they are finally REMOVED in future releases. Usually, deprecated APIs/fields are replaced by new APIs/fields. You are strongly recommended to migrate the usage of all deprecated APIs/fields to the new ones as soon as practicable.
-
Removed: APIs/fields that have been removed and will NOT be available in the release
September 2026
New
-
-
POST /oauth/revokeis now documented. Send either the access token or the refresh token; the whole authorization is revoked, including both tokens. -
The authorization stops issuing new tokens immediately. An access token that has already been issued is invalidated nearly immediately.
-
Updated
-
-
UTCtype work logs are returned again, reversing the July 2026 change that excluded them. They were the only source of the work description and photos for individually entered time cards, whichGET /timeCardsdoes not return. -
The
workLogTypefield advertisesCREW,STANDARDandUTCagain. -
New optional query parameter
workLogTypes— return only work logs of the given types, as a comma-separated list. When omitted, all three types are returned, so existing calls are unaffected. UseworkLogTypes=STANDARDfor the work logs shown on the Raken Work logs tab, andworkLogTypes=CREW,UTCfor those behind the Time cards tab. -
New section describing how work logs and time cards relate, and which endpoint holds which data.
-
-
-
New field
workLogUuid— the work log this time card belongs to. Use it to look up the card’s work description and photos, which are held on the work log and returned byGET /workLogs. -
Documented that
GET /timeCardsdoes not return the work description, and that thenoteandattachmentsfields are the time card’s own and are empty for most time cards.
-
-
-
New accepted value
SCHEDULEDfor thestatusesquery parameter and thestatusresponse field — checklists generated ahead of time from a recurring schedule, not yet started.
-
-
-
New accepted value
SCHEDULEDfor thestatusresponse field.
-
-
Date-range query parameters on the list endpoints are now validated for order. When the start of a range is later than its end — for example
changedSinceafterchangedUntil,fromCreatedAtaftertoCreatedAt,deletedFromafterdeletedTo,fromDateaftertoDate, orchecklistDateFromafterchecklistDateTo— the request is rejected with400 Validation Failedinstead of silently returning an empty result. Equal start and end values are still accepted. The documented 31-day range cap continues to apply where noted.
July 2026
New
-
-
New endpoint to fetch a single project by UUID.
-
Updated
-
-
New optional query parameter
query— filter projects by name or number (case-insensitive substring match).
-
-
-
New optional query parameter
query— filter members by name, employeeId, email, phone, or contact-company name (case-insensitive substring match).
-
-
-
New field
role— the Raken role of the user.
-
-
-
UTCtype work logs are no longer returned.GET /workLogsnow returns onlySTANDARDandCREWwork logs. Time card data remains available viaGET /timeCards.
-
June 2026
Updated
-
-
New field
companyUuid— the UUID of the company the authenticated user belongs to.
-
-
-
Added query parameter
projectUuids, which accepts a list of project UUIDs. At least one ofprojectUuidorprojectUuidsis now required.
-
Deprecated
-
-
Query parameter
projectUuidis deprecated and replaced byprojectUuids.
-
Removed
-
-
Query parameter
projectUuidsis removed
-
April 2026
Updated
-
-
The maximum value of the
limitquery parameter has been reduced from 1000 to 100
-
-
-
The maximum value of the
limitquery parameter has been reduced from 1000 to 100
-
-
-
The maximum value of the
limitquery parameter has been reduced from 1000 to 100
-
October 2025
Updated
-
-
Added support for UTC type work logs, GET work logs will now return STANDARD, CREW & UTC type work logs
-
August 2025
Updated
-
-
Include external and internal email recipients for each project in the response, via new
externalEmailRecipientsandinternalEmailRecipientsfields
-
-
Create Project and Update Project
-
Added new fields
externalEmailRecipientsandinternalEmailRecipientsto the request body for updating email recipients for a project
-
February 2025
Updated
-
-
Adding timestamp query params
deletedFromanddeletedTo. When provided only deleted time cards will be fetched -
Adding response field
deletedAt, which will only be populated for deleted time cards and will hold the timestamp of the deletion
-
Updated
-
-
Removing fields
timeCards.createdByKioskandtimeCards.inFlightTimeCardfrom time cards response
-
January 2025
Updated
-
API: members APIs
-
Removing field
timeSettings.defaultPayTypefrom members response
-
October 2024
New
-
API: GET groups
-
Added new endpoint for listing all groups for your Raken account.
-
Updated
-
API: GET checklists
-
Added support for querying checklists for dates within a specified datetime range using the parameters
checklistDateFromandchecklistDateFrom. -
Field
checklistDatehas been added to the response
-
Updated
-
API: Equipment Logs
-
Param
projectUuidhas been changed toprojectUuids, is now optional, and accepts a list -
Added support for querying equipment logs created within a specified datetime range using the parameters
fromCreatedAtandtoCreatedAt. -
Added support for querying equipment logs for specific pieces of equipment using the parameter
equipmentUuids. -
Added support for querying equipment logs for specific statuses using the parameter
status. -
Added support for querying equipment logs with equipment matching a query string using the parameter
query. -
Response structure has been modified
-
May 2024
Removed
-
-
Fields
costCodeUuid,costCodeCode,costCodeDescriptionare removed. -
Fields
materialUuid,materialName,materialUnitNameare removed.
-
March 2024
Updated
-
-
Added support for querying observations updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
-
-
Added support for querying work logs updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
-
-
Added support for querying material logs updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
-
-
Added support for querying equipment logs updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
-
-
Added support for querying daily reports updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
-
-
Added support for querying members updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
-
-
Added
materialUnit.namein the response of List/Create/Update.
-
Deprecated
-
-
Fields
costCodeUuid,costCodeCode,costCodeDescriptionare deprecated and replaced bycostCode. -
Fields
materialUuid,materialName,materialUnitNameare deprecated and replaced bymaterialandmaterial.materialUnit.
-
Removed
-
-
Fields
timeCards[].lunchStartTime,timeCards[].lunchDuration,timeCards[].breakStartTime,timeCards[].breakDurationare removed. -
Fields
timeCards[].created,timeCards[].updatedare removed. -
Fields
timeCards[].timeEntries[].payTypeCode,timeCards[].timeEntries[].classificationUuid,timeCards[].timeEntries[].costCodeUuidare removed.
-
-
-
Query parameter
statusis removed.
-
-
-
Fields
equipmentUuid,equipmentName,equipmentRate,equipmentFrequency,equipmentIdare removed and replaced byequipment.
-
February 2024
Updated
-
-
Added support for querying code codes updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
-
-
Added support for querying time cards updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
-
-
Added support for querying projects updated within a specified datetime range using the parameters
changedSinceandchangedUntil.
-
January 2024
Updated (Breaking change)
-
-
Fields
timeCards[].createdByare replaced with an object (uuid with a name), previously was an email. -
Fields
timeCards[].updatedByare replaced with an object (uuid with a name), previously was an email.
-
-
-
Fields
createdByare replaced with an object (uuid with a name), previously was an email -
Fields
updatedByare replaced with an object (uuid with a name), previously was an email.
-
December 2023
Updated
-
Checklists: API users are now able to filter checklists by checklist type. New fields associated with Checklists are added.
November 2023
New
-
Checklist Types: API users are now able to get all checklist types in Raken.
Updated
-
Checklists: API users are now able to see a checklist type associated with checklist templates.
October 2023
New
-
Observations: API users are now able to get an observation by UUID.
-
Observations: API users are now able to list all observations in Raken.
August 2023
Updated
-
Projects: get production insights now supports an additional query parameter
costCodeUuid. -
Projects: get production insights now supports an additional query parameter
costCodeDivision.
January 2023
New
-
Projects: API users now able to get members of a project.
November 2022
New
-
Past Toolbox Talks: API users are now able to list past toolbox talks in Raken.
-
Projects: API users now able to get production insights for a project in Raken.
Updated
-
-
Field
namerepresenting work log name added to response. -
Support to query for Child project using
projectUuidparameter -
Support to query by Work log status
COMPLETEDby default.
-
-
The
fileNamefield for attachment is added to the API response. This affects all GET API endpoints that return attachment objects in their response.
Deprecated
-
-
Fields
timeCards[].lunchStartTime,timeCards[].lunchDuration,timeCards[].breakStartTime,timeCards[].breakDurationare deprecated and replaced bytimeCards[].breaks[].startTime&timeCards[].breaks[].duration. -
Removed support for
WorklogType.PERSON
-
-
-
Deprecated and replaced by Members
-
-
-
jwt_tokenis deprecated, useaccess_tokeninstead.
-
Removed
-
-
HTTP request header
Authenticationsupport is removed. The standardAuthorizationheader is mandatory.
-
October 2022
New
-
Time Cards: API users are now able to list all time cards in Raken.
-
Daily Reports: API users are now able to list all daily reports in Raken.
September 2022
New
-
Toolbox Talks: API users are now able to list all toolbox talks in Raken.
-
Shifts: API users are now able to list all the shifts, and create & update a shift in Raken.
-
Projects: API users now able to get child projects for a parent project.
-
Projects: API users now able to get notes attached to a project.
Updated
-
-
New field in Work Logs:
timeCards[].timeEntries[].shift.uuid
-
-
-
New query parameter
classificationUuidsfor querying members by one or more classification UUIDs
-
-
-
New query parameters
templateUuid,createdByUuid,fromCreatedAtandtoCreatedAtfor querying checklists
-
August 2022
New
-
Classifications: API users are now able to create a classification in Raken.
-
Materials: API users are now able to list all the materials, and create & update a material in Raken.
-
Material Units: API users are now able to list all material units, and create a material unit in Raken.
-
Budgets: API users are now able to list all budgets in Raken.
-
Users: API users are now able to get the info of the user who is making API calls to Raken.
-
Checklists: API users are now able to list all checklists, or get an individual checklist with the response details, in Raken.
-
Checklists: API users are now able to list all checklist templates in Raken.
Updated
-
-
New query parameter
rolesfor returning only members with the given roles.
-
Deprecated
-
-
Fields
timeCards[].timeEntries[].payTypeCodeis deprecated and replaced bytimeCards[].timeEntries[].payType. -
Fields
timeCards[].timeEntries[].classificationUuidis deprecated and replaced bytimeCards[].timeEntries[].classification. -
Fields
timeCards[].timeEntries[].costCodeUuidis deprecated and replaced bytimeCards[].timeEntries[].costCode.
-
-
-
Query parameter
statusis deprecated and replaced bystatuses.
-
-
-
HTTP request header
Authenticationis deprecated and replaced byAuthorization.
-
Removed
-
-
Fields
timeCards[].shiftUuid/shiftName/shiftCodeare removed. Shift is available ONLY on the time entry level (timeCards[].timeEntries[].shift).
-
July 2022
Updated
-
-
New fields in Project:
createdAtandupdatedAt
-
-
-
New fields
createdAt&updatedAt
-
Deprecated
-
-
Query parameter
projectStatesis deprecated and replaced bystatuses.
-
-
-
Fields
timeCards[].created&timeCards[].updatedare deprecated and replaced bytimeCards[].createdAt&timeCards[].updatedAt.
-