tours

Guided Tours

The caller's own progress through the in-app guided tours (started, finished, dismissed).

2 endpoints

GET `/api/v1/me/tours`

Every guided tour the caller has started, finished or dismissed.

Requires authenticationScopeNo additional permission

curl example

curl

curl -X GET "https://your-institute.example/api/v1/me/tours" \
  -H "Authorization: Bearer $INSTITFLOW_API_KEY"

Responses

200

Name	Type	Constraints
toursrequired	array<object>	—

json

{
  "tours": [
    {
      "tourId": "first-login.owner",
      "status": "started",
      "lastStep": 0,
      "updatedAt": "2026-03-02T09:00:00.000Z"
    }
  ]
}

400The request could not be read at all — unparseable body, unusable content type, oversized payload (`MALFORMED_REQUEST`). Never a schema failure: those are 422.

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

401Missing, expired or invalid credentials (`UNAUTHORIZED`, `TOKEN_INVALID`, `SESSION_REVOKED`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

402The tenant’s subscription or license is locked (`PAYMENT_REQUIRED`, `SUBSCRIPTION_SUSPENDED`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

403Authenticated, but not allowed (`FORBIDDEN`, `FEATURE_DISABLED`, `QUOTA_EXCEEDED`, …).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

404No such resource, or it is not visible to this tenant (`NOT_FOUND`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

409Conflicts with current state (`CONFLICT`, `VERSION_CONFLICT`, `IDEMPOTENCY_KEY_REUSED`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

422The request was read but its content is not acceptable: body/query/path/header failed schema validation (`VALIDATION_ERROR`, with `details.issues`), or a domain rule rejected a well-formed value (`VIDEO_URL_INVALID`, …).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

429Rate limit exceeded — see the `RateLimit-*` and `Retry-After` headers (`RATE_LIMITED`).

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

500Unexpected server error (`INTERNAL_ERROR`). Never carries a stack trace or SQL.

Returns the shared `ErrorEnvelope` — `{ error: { code, message, requestId, details? } }`. Every code is listed in the Conventions guide.

PUT `/api/v1/me/tours/{tourId}`

Saves the caller's own progress in one tour (also used to restart a finished or dismissed one).

Requires authenticationScopeNo additional permission

Path & query parameters

Name	In	Type	Constraints
tourIdrequired	path	string	—

Request body

Name	Type	Constraints
statusrequired	enum: "started" \| "completed" \| "dismissed"	—
lastSteprequired	integer	0–49

Example

json

{
  "status": "started",
  "lastStep": 0
}

curl example

curl

curl -X PUT "https://your-institute.example/api/v1/me/tours/1de6160e-1de6-7de6-8e61-1de6160e1de6" \
  -H "Authorization: Bearer $INSTITFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "status": "started",
    "lastStep": 0
  }'

Responses

200

Name	Type	Constraints
tourIdrequired	enum: "first-login.owner" \| "first-login.teacher" \| "first-login.student" \| "first-login.guardian" \| "task.add-student" \| "task.add-student-to-course" \| "task.invite-student" \| "task.course-video-quiz" \| "task.lesson-files" \| "task.take-attendance" \| "task.issue-invoice" \| "task.message-parents"	—
statusrequired	enum: "started" \| "completed" \| "dismissed"	—
lastSteprequired	integer	0–9007199254740991
updatedAtrequired	string (date-time)	—

json

{
  "tourId": "first-login.owner",
  "status": "started",
  "lastStep": 0,
  "updatedAt": "2026-03-02T09:00:00.000Z"
}