Runn

<a href="https://help.runn.io/en/articles/8579592-api-v1-beta">API v1 is available in beta</a>. We encourage all developers to start using v1. Details about the sunsetting of v0 will be coming soon.

Runn is currently at v0 of it's API. This means we regularly update and change our API.

We do our best to ensure a 3 month warning period for any breaking changes with the exception of <code>_unstable</code> APIs. ​ Runn is planning to transition to v1. After the full release of v1, we will provide continued support of v0 for at least 6 months.

NEW: Add <code>GET projects/:id/other_expenses</code> for showing project expenses

NEW: Add <code>POST projects/:id/other_expenses</code> for creating project expenses

NEW: Add <code>PUT projects/:id/other_expenses/:expense_id</code> for updating project expenses

NEW: Add <code>DELETE projects/:id/other_expenses/:expense_id</code> for deleting project expenses

NEW: Add <code>PUT projects/:id/lock_timesheets</code> to lock a specific project timesheet to a date.

- NEW: Add <code>GET projects/:id/other_expenses</code> for showing project expenses
- NEW: Add <code>POST projects/:id/other_expenses</code> for creating project expenses
- NEW: Add <code>PUT projects/:id/other_expenses/:expense_id</code> for updating project expenses
- NEW: Add <code>DELETE projects/:id/other_expenses/:expense_id</code> for deleting project expenses
- NEW: Add <code>PUT projects/:id/lock_timesheets</code> to lock a specific project timesheet to a date.

All <code>skills_unstable</code> can now be accessed as <code>skills</code> - this is a straight change with no breaking changes.

NEW: Add <code>GET /skills</code> for listing skills

NEW: Add <code>POST /skills</code> for creating skills

NEW: Add <code>GET /skills/:id</code> for a single skill

NEW: Add <code>PUT /skills/:id</code> for updating a single skill

NEW: Add <code>DELETE /skills/:id</code> for deleting a single skill

NEW: Add <code>skills</code> property to <code>people</code>

FUTURE DEPRECATION: From 2023-05-29 all <code>skill_unstable</code> endpoints will be removed. They have now been hidden from documentation and swagger.

- All <code>skills_unstable</code> can now be accessed as <code>skills</code> - this is a straight change with no breaking changes.
- NEW: Add <code>GET /skills</code> for listing skills
- NEW: Add <code>POST /skills</code> for creating skills
- NEW: Add <code>GET /skills/:id</code> for a single skill
- NEW: Add <code>PUT /skills/:id</code> for updating a single skill
- NEW: Add <code>DELETE /skills/:id</code> for deleting a single skill
- NEW: Add <code>skills</code> property to <code>people</code>
- FUTURE DEPRECATION: From 2023-05-29 all <code>skill_unstable</code> endpoints will be removed. They have now been hidden from documentation and swagger.

DEPRECATED: All endpoints are now paginated.

- DEPRECATED: All endpoints are now paginated.

NEW: Add <code>GET /skills_unstable</code> for listing skills

NEW: Add <code>POST /skills_unstable</code> for creating skills

NEW: Add <code>GET /skills_unstable/:id</code> for a single skill

NEW: Add <code>PUT /skills_unstable/:id</code> for updating a single skill

NEW: Add <code>DELETE /skills_unstable/:id</code> for deleting a single skill

NEW: Add <code>skills_unstable</code> property to <code>people</code>

DEPRECATED: Removed <code>total_minutes</code> on <code>assignments</code>

- NEW: Add <code>GET /skills_unstable</code> for listing skills
- NEW: Add <code>POST /skills_unstable</code> for creating skills
- NEW: Add <code>GET /skills_unstable/:id</code> for a single skill
- NEW: Add <code>PUT /skills_unstable/:id</code> for updating a single skill
- NEW: Add <code>DELETE /skills_unstable/:id</code> for deleting a single skill
- NEW: Add <code>skills_unstable</code> property to <code>people</code>
- DEPRECATED: Removed <code>total_minutes</code> on <code>assignments</code>

FUTURE DEPRECATION: From 2022-10-24 all get requests will have pagination added to them.

- FUTURE DEPRECATION: From 2022-10-24 all get requests will have pagination added to them.

NEW: Pagination now follows the <a href="https://datatracker.ietf.org/doc/html/rfc5988" rel="nofollow noopener noreferrer" target="_blank">RFC5988</a> specifications

FUTURE DEPRECATION: From 2022-08-15 <code>total_minutes</code> will be removed from the <code>assignments</code> model

- NEW: Pagination now follows the <a href="https://datatracker.ietf.org/doc/html/rfc5988" rel="nofollow noopener noreferrer" target="_blank">RFC5988</a> specifications
- FUTURE DEPRECATION: From 2022-08-15 <code>total_minutes</code> will be removed from the <code>assignments</code> model

NEW: Add <code>PUT /roles/:id</code> for updating existing roles

NEW: Add <code>POST /teams</code> for creating a team

NEW: Add <code>PUT /teams/:ids</code> for updating a team

NEW: Add <code>DELETE /teams/:id</code> for deleting a team

FIX: Fix bug in <code>POST /people/:id/contracts</code> that failed when no current contract exists

- NEW: Add <code>PUT /roles/:id</code> for updating existing roles
- NEW: Add <code>POST /teams</code> for creating a team
- NEW: Add <code>PUT /teams/:ids</code> for updating a team
- NEW: Add <code>DELETE /teams/:id</code> for deleting a team
- FIX: Fix bug in <code>POST /people/:id/contracts</code> that failed when no current contract exists

DEPRECATED: Removed <code>people.projects</code> as being automatically returned from <code>GET /people</code> - you can continue with this behaviour by using <code>?include_projects=true</code> however this does come with a performance penalty.

- DEPRECATED: Removed <code>people.projects</code> as being automatically returned from <code>GET /people</code> - you can continue with this behaviour by using <code>?include_projects=true</code> however this does come with a performance penalty.

NEW: Add <code>GET /actuals</code>

FIX: Correct some types showing <code>id</code> as <code>number</code> instead of <code>string</code>

- NEW: Add <code>GET /actuals</code> 
- FIX: Correct some types showing <code>id</code> as <code>number</code> instead of <code>string</code>
- FIX: Fix bug in <code>POST /people/:id/contracts</code> that failed when no current contract exists

NEW: Add <code>DELETE /people/{id}/contracts/{contract_id}</code>

ADDITION: Add <code>sent_date</code> to <code>GET /invitations</code>

- NEW: Add <code>DELETE /people/{id}/contracts/{contract_id}</code>
- ADDITION: Add <code>sent_date</code> to <code>GET /invitations</code>

NEW: Add <code>GET /milestones</code>

- NEW: Add <code>GET /milestones</code>

FUTURE DEPRECATION: From 2022-04-19 <code>GET /people</code> will no longer return projects that people are working on by default. You will need to pass <code>?include_projects=true</code> - this will result in a 3x speed increase for those who do not need this data.

ADDITION: You may now add <code>include_projects=false</code> to <code>GET /people</code> to increase the speed of this request.

- FUTURE DEPRECATION: From 2022-04-19 <code>GET /people</code> will no longer return projects that people are working on by default. You will need to pass <code>?include_projects=true</code> - this will result in a 3x speed increase for those who do not need this data.
- ADDITION: You may now add <code>include_projects=false</code> to <code>GET /people</code> to increase the speed of this request.

Upcoming Deprecations

Changes