Getting started

2 operations in the Tolvi API, version 1. Paths are relative to https://api.tolvi.co.uk. Every amount is integer pence.

Get your welcome tour progress

GET/api/v1/me/tour-state

Not started until you first open the tour.

Parameters for GET /api/v1/me/tour-state
Name	In	Type	Description
`product`	query	`string (TourProduct)`	Which product’s tour: each has its own short one. Defaults to working_papers, the original welcome tour. One of: `working_papers`, `meetings`, `admin`

Body: object (TourState).

Your progress through the welcome tour in this firm, and whether you have hidden the Getting started checklist.

200 OK response for GET /api/v1/me/tour-state
Field	Type	Description
`status`required	`string (TourStatus)`	not_started: never opened (the web app starts it). in_progress: open, or left part-way. skipped: closed early; it can be resumed from Help. completed: finished. One of: `not_started`, `in_progress`, `skipped`, `completed`
`stepId`required	`string`nullable	The step to resume at; null for the first step. example "add-client"
`checklistHidden`required	`boolean`	The Getting started checklist on the Work page is hidden.
`updatedAt`required	`string (date-time)`nullable	Null until you first open the tour or hide the checklist.

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 429 Too many requests, as problem details (application/problem+json).

PUT/api/v1/me/tour-state

Only the fields sent are changed.

Parameters for PUT /api/v1/me/tour-state
Name	In	Type	Description
`product`	query	`string (TourProduct)`	Which product’s tour: each has its own short one. Defaults to working_papers, the original welcome tour. One of: `working_papers`, `meetings`, `admin`

Required. application/json: object (TourStatePatch).

Only the fields sent are changed.

Request body for PUT /api/v1/me/tour-state
Field	Type	Description
`status`	`string (TourStatus)`	not_started: never opened (the web app starts it). in_progress: open, or left part-way. skipped: closed early; it can be resumed from Help. completed: finished. One of: `not_started`, `in_progress`, `skipped`, `completed`
`stepId`	`string`nullable	up to 40 characters; pattern ^[a-z][a-z0-9-]{0,39}$
`checklistHidden`	`boolean`

Body: object (TourState).

Your progress through the welcome tour in this firm, and whether you have hidden the Getting started checklist.

200 OK response for PUT /api/v1/me/tour-state
Field	Type	Description
`status`required	`string (TourStatus)`	not_started: never opened (the web app starts it). in_progress: open, or left part-way. skipped: closed early; it can be resumed from Help. completed: finished. One of: `not_started`, `in_progress`, `skipped`, `completed`
`stepId`required	`string`nullable	The step to resume at; null for the first step. example "add-client"
`checklistHidden`required	`boolean`	The Getting started checklist on the Work page is hidden.
`updatedAt`required	`string (date-time)`nullable	Null until you first open the tour or hide the checklist.

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 429 Too many requests, as problem details (application/problem+json).