API Changelog

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.

When Runn transitions to V1 - we will provide at least 6 months of support for v0.

Upcoming Deprecations

• pagination will be added to all GET requests on 2022-10-24 - depending on the endpoint the pagination will be between 100 and 500 records. To assist with this, pagination will be added to all GET request with an initial limit of 5000 items.

• total_minutes on assignments will be removed on 2022-08-15 - This value can become inaccurate and should not be used. This is a fast deprecation because it is currently incorrect.

Changes

2022-09-05

• NEW: Add GET /skills_unstable for listing skills

• NEW: Add POST /skills_unstable for creating skills

• NEW: Add GET /skills_unstable/:id for a single skill

• NEW: Add PUT /skills_unstable/:id for updating a single skill

• NEW: Add DELETE /skills_unstable/:id for deleting a single skill

• NEW: Add skills_unstable property to people

2022-07-25

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

2022-07-18

• NEW: Pagination now follows the RFC5988 specifications

• FUTURE DEPRECATION: From 2022-08-15 total_minutes will be removed from the assignments model

2022-05-16

• NEW: Add PUT /roles/:id for updating existing roles

• NEW: Add POST /teams for creating a team

• NEW: Add PUT /teams/:ids for updating a team

• NEW: Add DELETE /teams/:id for deleting a team

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

2022-04-13

• NEW: Add GET /actuals

• FIX: Correct some types showing id as number instead of string

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

2022-03-20

• NEW: Add DELETE /people/{id}/contracts/{contract_id}

• ADDITION: Add sent_date to GET /invitations

2022-02-14

• NEW: Add GET /milestones

2022-01-17

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

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