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

  • Revoking access

    • POST /oauth/revoke is 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

  • List Work Logs

    • UTC type 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, which GET /timeCards does not return.

    • The workLogType field advertises CREW, STANDARD and UTC again.

    • 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. Use workLogTypes=STANDARD for the work logs shown on the Raken Work logs tab, and workLogTypes=CREW,UTC for those behind the Time cards tab.

    • New section describing how work logs and time cards relate, and which endpoint holds which data.

  • List Time Cards

    • 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 by GET /workLogs.

    • Documented that GET /timeCards does not return the work description, and that the note and attachments fields are the time card’s own and are empty for most time cards.

  • List Checklists

    • New accepted value SCHEDULED for the statuses query parameter and the status response field — checklists generated ahead of time from a recurring schedule, not yet started.

  • Get Checklist

    • New accepted value SCHEDULED for the status response 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 changedSince after changedUntil, fromCreatedAt after toCreatedAt, deletedFrom after deletedTo, fromDate after toDate, or checklistDateFrom after checklistDateTo — the request is rejected with 400 Validation Failed instead 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

  • Get Project

    • New endpoint to fetch a single project by UUID.

Updated

  • List Projects

    • New optional query parameter query — filter projects by name or number (case-insensitive substring match).

  • List Members

    • New optional query parameter query — filter members by name, employeeId, email, phone, or contact-company name (case-insensitive substring match).

  • Get User Info

    • New field role — the Raken role of the user.

  • List Work Logs

    • UTC type work logs are no longer returned. GET /workLogs now returns only STANDARD and CREW work logs. Time card data remains available via GET /timeCards.

June 2026

Updated

  • Get User Info

    • New field companyUuid — the UUID of the company the authenticated user belongs to.

  • List Observations

    • Added query parameter projectUuids, which accepts a list of project UUIDs. At least one of projectUuid or projectUuids is now required.

Deprecated

  • List Observations

    • Query parameter projectUuid is deprecated and replaced by projectUuids.

Removed

April 2026

Updated

  • List Checklists

    • The maximum value of the limit query parameter has been reduced from 1000 to 100

  • List Checklist Templates

    • The maximum value of the limit query parameter has been reduced from 1000 to 100

  • List Checklist Types

    • The maximum value of the limit query parameter has been reduced from 1000 to 100

October 2025

Updated

  • List Work Logs

    • Added support for UTC type work logs, GET work logs will now return STANDARD, CREW & UTC type work logs

August 2025

Updated

  • List Projects

    • Include external and internal email recipients for each project in the response, via new externalEmailRecipients and internalEmailRecipients fields

  • Create Project and Update Project

    • Added new fields externalEmailRecipients and internalEmailRecipients to the request body for updating email recipients for a project

July 2025

New

February 2025

Updated

  • List Time Cards

    • Adding timestamp query params deletedFrom and deletedTo. 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

  • List Time Cards

    • Removing fields timeCards.createdByKiosk and timeCards.inFlightTimeCard from time cards response

January 2025

Updated

  • API: members APIs

    • Removing field timeSettings.defaultPayType from members response

November 2024

New

  • API: PATCH groups

    • Added new endpoint for updating groups for your Raken account.

New

  • API: PATCH certifications

    • Added new endpoint for updating certifications for your Raken account.

New

  • API: POST groups

    • Added new endpoint for creating groups for your Raken account.

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 checklistDateFrom and checklistDateFrom.

    • Field checklistDate has been added to the response

Updated

  • API: Equipment Logs

    • Param projectUuid has been changed to projectUuids, is now optional, and accepts a list

    • Added support for querying equipment logs created within a specified datetime range using the parameters fromCreatedAt and toCreatedAt.

    • 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

June 2024

Removed

May 2024

Removed

  • List Material Logs

    • Fields costCodeUuid, costCodeCode, costCodeDescription are removed.

    • Fields materialUuid, materialName, materialUnitName are removed.

March 2024

Updated

  • List Observations

    • Added support for querying observations updated within a specified datetime range using the parameters changedSince and changedUntil.

  • List Work Logs

    • Added support for querying work logs updated within a specified datetime range using the parameters changedSince and changedUntil.

  • List Material Logs

    • Added support for querying material logs updated within a specified datetime range using the parameters changedSince and changedUntil.

  • List Equipment Logs

    • Added support for querying equipment logs updated within a specified datetime range using the parameters changedSince and changedUntil.

  • List Daily Reports

    • Added support for querying daily reports updated within a specified datetime range using the parameters changedSince and changedUntil.

  • List Members

    • Added support for querying members updated within a specified datetime range using the parameters changedSince and changedUntil.

  • List Materials

    • Added materialUnit.name in the response of List/Create/Update.

Deprecated

  • List Material Logs

    • Fields costCodeUuid, costCodeCode, costCodeDescription are deprecated and replaced by costCode.

    • Fields materialUuid, materialName, materialUnitName are deprecated and replaced by material and material.materialUnit.

Removed

  • List Work Logs

    • Fields timeCards[].lunchStartTime, timeCards[].lunchDuration, timeCards[].breakStartTime, timeCards[].breakDuration are removed.

    • Fields timeCards[].created, timeCards[].updated are removed.

    • Fields timeCards[].timeEntries[].payTypeCode, timeCards[].timeEntries[].classificationUuid, timeCards[].timeEntries[].costCodeUuid are removed.

  • List Classifications

    • Query parameter status is removed.

  • List Equipment Logs

    • Fields equipmentUuid, equipmentName, equipmentRate, equipmentFrequency, equipmentId are removed and replaced by equipment.

February 2024

Updated

  • List Cost Codes

    • Added support for querying code codes updated within a specified datetime range using the parameters changedSince and changedUntil.

  • List Time Cards

    • Added support for querying time cards updated within a specified datetime range using the parameters changedSince and changedUntil.

  • List Projects

    • Added support for querying projects updated within a specified datetime range using the parameters changedSince and changedUntil.

  • Classifications

    • Added support to list for querying classifications updated within a specified datetime range using the parameters changedSince and changedUntil.

    • Enhanced response body to include updatedAt and createdAt fields, for both list and create classifications.

January 2024

Updated (Breaking change)

  • List Work Logs

    • Fields timeCards[].createdBy are replaced with an object (uuid with a name), previously was an email.

    • Fields timeCards[].updatedBy are replaced with an object (uuid with a name), previously was an email.

  • List Time Cards

    • Fields createdBy are replaced with an object (uuid with a name), previously was an email

    • Fields updatedBy are 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

Updated

  • Checklists: API users are now able to see a checklist type associated with checklist templates.

October 2023

New

Updated

Removed

August 2023

Updated

February 2023

Updated

  • Members: create requires the email field to create a team member.

New

January 2023

New

December 2022

New

  • Members: API users are now able to get a project member by UUID.

  • Members: API users are now able to list projects for a member by UUID.

Updated

November 2022

New

Updated

  • List Work Logs

    • Field name representing work log name added to response.

    • Support to query for Child project using projectUuid parameter

    • Support to query by Work log status COMPLETED by default.

  • The fileName field for attachment is added to the API response. This affects all GET API endpoints that return attachment objects in their response.

Deprecated

  • List Work Logs

    • Fields timeCards[].lunchStartTime, timeCards[].lunchDuration, timeCards[].breakStartTime, timeCards[].breakDuration are deprecated and replaced by timeCards[].breaks[].startTime & timeCards[].breaks[].duration.

    • Removed support for WorklogType.PERSON

  • Workers

    • Deprecated and replaced by Members

  • Authorization

    • jwt_token is deprecated, use access_token instead.

Removed

  • Request Headers

    • HTTP request header Authentication support is removed. The standard Authorization header is mandatory.

October 2022

New

September 2022

New

Updated

  • List Work Logs

    • New field in Work Logs: timeCards[].timeEntries[].shift.uuid

  • List Members

    • New query parameter classificationUuids for querying members by one or more classification UUIDs

  • List Checklists

    • New query parameters templateUuid, createdByUuid, fromCreatedAt and toCreatedAt for 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

  • List Members

    • New query parameter roles for returning only members with the given roles.

Deprecated

  • List Work Logs

    • Fields timeCards[].timeEntries[].payTypeCode is deprecated and replaced by timeCards[].timeEntries[].payType.

    • Fields timeCards[].timeEntries[].classificationUuid is deprecated and replaced by timeCards[].timeEntries[].classification.

    • Fields timeCards[].timeEntries[].costCodeUuid is deprecated and replaced by timeCards[].timeEntries[].costCode.

  • List Classifications

    • Query parameter status is deprecated and replaced by statuses.

  • Request Headers

    • HTTP request header Authentication is deprecated and replaced by Authorization.

Removed

  • List Work Logs

    • Fields timeCards[].shiftUuid/shiftName/shiftCode are removed. Shift is available ONLY on the time entry level (timeCards[].timeEntries[].shift).

July 2022

New

Updated

Deprecated

  • List Projects

    • Query parameter projectStates is deprecated and replaced by statuses.

  • List Work Logs

    • Fields timeCards[].created & timeCards[].updated are deprecated and replaced by timeCards[].createdAt & timeCards[].updatedAt.