• Added ability to retrieve a list of projects for a client
  • GET /clients/{clientId}/projects
• Added support to delete specific timesheet entries
  • DELETE /actuals/{actualId}

Please read this article to learn more about some upcoming permission changes in Runn and how they may affect your integration.

🚧

Across the next few months, we will be undertaking some improvements to user permissions in Runn. Learn more

API v1

GET /users

• The "type" of some users will be renamed
  • "Editor" & "Viewer All" will be consolidated into a new type called "Manager"
  • "Viewer Basic" and "Timesheet Only" will be consolidated into a new type called "Contributor"
• Some of the permission properties have already been expanded for some users in your organisation. These new permissions properties are needed for the upcoming "Manager" user type that will replace the "Editor" and "Viewer All" account types. Unless you are utilising these properties specifically you won't need to make any changes to your integration.

Here is an example of the permissions for an existing Editor that has access to manage specific projects

"permissions": { "type": "editor", "financial": "none", "editProjects": "specific", "manageProjects": "restricted", "editOthers": "none", "manageOthers": "none" }

Once the permissions rollout is complete you'll notice the "type" of some users will change to the new user types being introduced (ie. Manager & Contributor). For the user above you'll just notice the "type" changes to "manager".

"permissions": { "type": "manager", "financial": "none", "editProjects": "specific", "manageProjects": "restricted", "editOthers": "none", "manageOthers": "none" }

POST /invitations

We'll soon be releasing the v1 version of POST /invitations and this will use the new user types and permissions. Once released the API Reference will contain all the details of this new API v1 endpoint.

API v0

POST /api/v0/invitations

• Existing permission types that are used with POST /api/v0/invitations will continue to be accepted and will mapped to their equivalent new user type.

We recommend migrating to API v1 to take advantage of the new permission types as soon as you can. API v0 is being sunset on January 6, 2025.

GET /api/v0/users

Similar to API v1 the GET users endpoint will include

• Changes include the "type" and some permission properties - see the notes above

Support

If you have any questions. You can reach us at [email protected]

• Fixes for project rates, project phases, project notes & custom fields
  • PATCH /projects/{id}/project-rates/{rate_id}
    • Only accept positive values for rates
  • GET /projects/{projectId}/phases/
    • the 201 response property values/items/color will no longer be null
  • GET /projects/{projectId}/phases/{phaseId}
    • the 200 response property color will no longer be null
  • POST /projects/{projectId}/phases/
    • the request property color is still optional, but will now default to a color instead of null
    • the 201 response property color will no longer be null
  • DELETE /projects/{projectId}/phases/{phaseId}
    • the 204 response property color will no longer be null
  • POST /projects/{projectId}/notes/
    • the 201 response property createdBy may be null now
  • PATCH /custom-fields/select/{selectFieldId}
    • you can no longer change the the singleSelect property

• Permissions improvements for upcoming permission changes.
  • GET /invitations
    • The value of these enums may now also be restricted
      • values/items/editProjectsPermission
      • values/items/financialPermission
    • the 200 response property has two new properties:
      • values/items/manageOthersPermission
      • values/items/manageProjectsPermission
  • GET /users/
    • The value of these enums may now also be restricted
      • values/items/permissions/editProjects
      • values/items/permissions/financial
    • the 200 response property has two new properties:
      • values/items/permissions/manageOthers
      • values/items/permissions/manageProjects
  • GET /users/{userId}
    • The value of these enums may now also be restricted
      • permissions/editProjects
      • permissions/financial
    • the 200 response property has two new properties:
      • permissions/manageOthers
      • permissions/manageProjects

• Added ability to add "Other Expenses" to projects
  • POST /projects/{id}/other-expenses

• Fix for preventing a person being archived with future assignments on an active project
  • PATCH /people/{id}

• Added ability to get notes for projects
  • GET /projects/{id}/notes

API v1 is now out of beta and is the recommended API to use for all new integrations. API v0 will be sunset on January 6, 2025. See our Migrating from API v0 guide .Thanks to everyone that has given us bug reports and suggestions for improvement. Please keep letting us know what you'd like us to work on next.

• Improved Endpoint pagination - only return nextCursor when there is more data to fetch

• Support for removing all tags in PATCH endpoints for projects & people