Botree LRS API

Version 0.43.1 · OpenAPI 3.1.0

Base URL: https://lrs.botreeinc.com

Home Dashboard Raw openapi.json

Authentication

The access token every request carries, and where it comes from.

Service accounts

Connecting a program — a Claude Code session, a script — as an account of its own.

Permissions

The permission strings department roles grant, and what each unlocks.

Endpoints

306 endpoints in 26 groups, one page per group.

Schemas

321 request and response bodies, one page per schema.

Endpoints

Every operation, grouped by area. Each area has its own page; an endpoint links to its card there.

auth 2 endpoints

GET/api/auth/token-info
GET/api/.well-known/oauth-protected-resource

directory 25 endpoints

GET/api/organizations
POST/api/organizations
PATCH/api/organizations/{organizationId}
POST/api/organizations/{organizationId}/departments
PATCH/api/organizations/{organizationId}/departments/{departmentId}
POST/api/organizations/{organizationId}/departments/{departmentId}/roles
PATCH/api/organizations/{organizationId}/departments/{departmentId}/roles/{roleId}
GET/api/organizations/{organizationId}/departments/{departmentId}/roles/{roleId}/permanent-deletion
DELETE/api/organizations/{organizationId}/departments/{departmentId}/roles/{roleId}/permanent-deletion
POST/api/organizations/{org_id}/users/import
GET/api/organizations/{org_id}/users
POST/api/organizations/{org_id}/users
GET/api/organizations/{org_id}/users/{user_id}
DELETE/api/organizations/{org_id}/users/{user_id}
GET/api/organizations/{org_id}/users/{user_id}/roles
POST/api/organizations/{org_id}/users/{user_id}/roles
PATCH/api/organizations/{org_id}/users/{user_id}/roles/{role_id}
DELETE/api/organizations/{org_id}/users/{user_id}/roles/{role_id}
GET/api/organizations/{organizationId}/departments/{departmentId}/roles/{roleId}/managers
POST/api/organizations/{organizationId}/departments/{departmentId}/roles/{roleId}/managers
DELETE/api/organizations/{organizationId}/departments/{departmentId}/roles/{roleId}/managers/{managerRoleId}
GET/api/organizations/{org_id}
GET/api/organizations/{org_id}/departments/{dept_id}
GET/api/organizations/{org_id}/departments/{dept_id}/roles
GET/api/organizations/{org_id}/departments/{dept_id}/roles/{role_id}

providers 5 endpoints

GET/api/providers
POST/api/providers
GET/api/providers/{provider_id}
PATCH/api/providers/{provider_id}
DELETE/api/providers/{provider_id}

users 13 endpoints

GET/api/users/me
DELETE/api/users/me/identities/{identity_id}
POST/api/users
GET/api/users/{user_id}/email-links
POST/api/users/{user_id}/email-links
DELETE/api/users/{user_id}/email-links/{link_id}
PATCH/api/users/{user_id}
GET/api/users/{user_id}/identities
POST/api/users/{user_id}/identities
DELETE/api/users/{user_id}/identities/{identity_id}
POST/api/users/{user_id}/merge
GET/api/users/{user_id}/permanent-deletion
DELETE/api/users/{user_id}/permanent-deletion

calendar-feeds 6 endpoints

GET/api/users/me/calendar-feeds
POST/api/users/me/calendar-feeds
POST/api/users/me/calendar-feeds/revoke-all
PATCH/api/users/me/calendar-feeds/{feed_id}
DELETE/api/users/me/calendar-feeds/{feed_id}
GET/api/calendar-feeds/{token}/calendar.ics

subjects 9 endpoints

GET/api/subjects
POST/api/subjects
GET/api/subjects/{subject_id}/permanent-deletion
DELETE/api/subjects/{subject_id}/permanent-deletion
GET/api/subjects/{subject_id}
PATCH/api/subjects/{subject_id}
DELETE/api/subjects/{subject_id}
GET/api/subjects/{subject_id}/hierarchy
PUT/api/subjects/{subject_id}/parents

records 17 endpoints

POST/api/records/submissions
GET/api/records
POST/api/records
GET/api/records/export.csv
GET/api/records/{record_id}/permanent-deletion
DELETE/api/records/{record_id}/permanent-deletion
GET/api/records/{record_id}
PATCH/api/records/{record_id}
DELETE/api/records/{record_id}
POST/api/records/{record_id}/approve
POST/api/records/{record_id}/reject
GET/api/records/{record_id}/evidence
POST/api/records/{record_id}/evidence
POST/api/records/{record_id}/evidence/uploads
PATCH/api/evidence/{evidence_id}
DELETE/api/evidence/{evidence_id}
GET/api/evidence/{evidence_id}/download

certification-status 16 endpoints

GET/api/certifications/status
POST/api/certifications/{cert_id}/claim
POST/api/certifications/{cert_id}/request
POST/api/certification-requests/{request_id}/withdraw
POST/api/certification-requests/{request_id}/approve
POST/api/certification-requests/{request_id}/reject
GET/api/certification-requests
POST/api/certifications/{cert_id}/grants
GET/api/certifications/{cert_id}/awards
POST/api/certification-awards/{award_id}/revoke
GET/api/certifications/{cert_id}/due-dates
PUT/api/certifications/{cert_id}/due-dates/{user_id}
DELETE/api/certifications/{cert_id}/due-dates/{user_id}
GET/api/certification-rules/{rule_id}/sign-offs
POST/api/certification-rules/{rule_id}/sign-offs
DELETE/api/certification-sign-offs/{sign_off_id}

certifications 21 endpoints

GET/api/certifications
POST/api/certifications
GET/api/certifications/{cert_id}/attachments/{attachment_id}/download
POST/api/certifications/{cert_id}/attachment-uploads
POST/api/certifications/{cert_id}/attachments
PATCH/api/certifications/{cert_id}/attachments/{attachment_id}
DELETE/api/certifications/{cert_id}/attachments/{attachment_id}
PUT/api/certifications/{cert_id}/subjects
GET/api/certifications/{cert_id}/permanent-deletion
DELETE/api/certifications/{cert_id}/permanent-deletion
POST/api/certifications/{cert_id}/duplicate
GET/api/certifications/{cert_id}
PATCH/api/certifications/{cert_id}
DELETE/api/certifications/{cert_id}
POST/api/certifications/{cert_id}/rules
PATCH/api/certification-rules/{rule_id}
DELETE/api/certification-rules/{rule_id}
GET/api/organizations/{org_id}/departments/{dept_id}/roles/{role_id}/required-certifications
POST/api/organizations/{org_id}/departments/{dept_id}/roles/{role_id}/required-certifications
PATCH/api/role-required-certifications/{link_id}
DELETE/api/role-required-certifications/{link_id}

team-completion 2 endpoints

GET/api/organizations/{organizationId}/departments/{departmentId}/roles/{roleId}/certification-completion
GET/api/team/certification-completion

quizzes 39 endpoints

PUT/api/quiz-banks/{bank_id}/questions/order
GET/api/quiz-banks/{bank_id}/questions
POST/api/quiz-banks/{bank_id}/questions
POST/api/quiz-banks/{bank_id}/question-pdfs
GET/api/quiz-questions/{question_id}/pdf
GET/api/quiz-banks/{bank_id}/permanent-deletion
DELETE/api/quiz-banks/{bank_id}/permanent-deletion
GET/api/quiz-banks
POST/api/quiz-banks
GET/api/quiz-banks/{bank_id}
PATCH/api/quiz-banks/{bank_id}
DELETE/api/quiz-banks/{bank_id}
POST/api/quiz-questions/{question_id}/copy
POST/api/quiz-questions/{question_id}/move
PATCH/api/quiz-questions/{question_id}
DELETE/api/quiz-questions/{question_id}
POST/api/quiz-questions/{question_id}/archive
GET/api/quizzes/{quiz_id}/attempts
GET/api/quizzes/{quiz_id}/attempts/export.csv
GET/api/quizzes/{quiz_id}/attempts/export.json
POST/api/quizzes/{quiz_id}/schedules
PATCH/api/quiz-schedules/{schedule_id}
DELETE/api/quiz-schedules/{schedule_id}
GET/api/quiz-schedules/{schedule_id}/participants
POST/api/quiz-schedules/{schedule_id}/participants
DELETE/api/quiz-schedule-participants/{participant_id}
GET/api/quizzes/{quiz_id}/assignments
POST/api/quizzes/{quiz_id}/assignments
DELETE/api/quiz-assignments/{assignment_id}
PUT/api/quizzes/{quiz_id}/banks
PUT/api/quizzes/{quiz_id}/subjects
POST/api/quizzes/{quiz_id}/publish
POST/api/quizzes/{quiz_id}/release-results
GET/api/quizzes/{quiz_id}
PATCH/api/quizzes/{quiz_id}
DELETE/api/quizzes/{quiz_id}
POST/api/quizzes/{quiz_id}/duplicate
GET/api/quizzes
POST/api/quizzes

quiz-taking 9 endpoints

GET/api/quizzes/assigned
POST/api/quizzes/{quiz_id}/attempts
GET/api/quiz-attempts/{attempt_id}/questions/{question_id}/pdf
GET/api/quiz-attempts/{attempt_id}/review.csv
GET/api/quiz-attempts/{attempt_id}/review.json
GET/api/quiz-attempts/{attempt_id}/review
GET/api/quiz-attempts/{attempt_id}
POST/api/quiz-attempts/{attempt_id}/answers
POST/api/quiz-attempts/{attempt_id}/submit

quiz-grading 5 endpoints

GET/api/grading-queue
GET/api/quiz-attempts/{attempt_id}/grading
PUT/api/quiz-attempts/{attempt_id}/grades/{question_id}
POST/api/quiz-attempts/{attempt_id}/finalize-grading
POST/api/quizzes/{quiz_id}/release-attempts

learning-pathways 27 endpoints

GET/api/learning-pathways/mine
GET/api/learning-pathways/{pathway_id}/progress
GET/api/learning-pathways/{pathway_id}/attachments/{attachment_id}/download
POST/api/learning-pathways/{pathway_id}/attachment-uploads
POST/api/learning-pathways/{pathway_id}/attachments
PATCH/api/learning-pathways/{pathway_id}/attachments/{attachment_id}
DELETE/api/learning-pathways/{pathway_id}/attachments/{attachment_id}
GET/api/learning-pathway-levels/{level_id}/attachments/{attachment_id}/download
POST/api/learning-pathway-levels/{level_id}/attachment-uploads
POST/api/learning-pathway-levels/{level_id}/attachments
PATCH/api/learning-pathway-levels/{level_id}/attachments/{attachment_id}
DELETE/api/learning-pathway-levels/{level_id}/attachments/{attachment_id}
PUT/api/learning-pathways/{pathway_id}/job-aids
PUT/api/learning-pathway-levels/{level_id}/job-aids
POST/api/learning-pathways/{pathway_id}/levels
PATCH/api/learning-pathway-levels/{level_id}
DELETE/api/learning-pathway-levels/{level_id}
POST/api/learning-pathways/{pathway_id}/phases
PATCH/api/learning-pathway-phases/{phase_id}
DELETE/api/learning-pathway-phases/{phase_id}
POST/api/learning-pathways/{pathway_id}/assignments
DELETE/api/learning-pathways/{pathway_id}/assignments/{assignment_id}
GET/api/learning-pathways
POST/api/learning-pathways
GET/api/learning-pathways/{pathway_id}
PATCH/api/learning-pathways/{pathway_id}
POST/api/learning-pathways/{pathway_id}/archive

external-lms 18 endpoints

GET/api/external-lms/servers
POST/api/external-lms/servers
POST/api/external-lms/servers/{server_id}/grades/import
GET/api/external-lms/servers/{server_id}/grades
POST/api/external-lms/servers/{server_id}/grades
GET/api/external-lms/servers/{server_id}/user-mappings
PUT/api/external-lms/servers/{server_id}/user-mappings
DELETE/api/external-lms/servers/{server_id}/user-mappings/{external_user_id}
GET/api/external-lms/servers/{server_id}/courses
POST/api/external-lms/servers/{server_id}/courses
GET/api/external-lms/courses/{course_id}/permanent-deletion
DELETE/api/external-lms/courses/{course_id}/permanent-deletion
GET/api/external-lms/servers/{server_id}
PATCH/api/external-lms/servers/{server_id}
DELETE/api/external-lms/servers/{server_id}
GET/api/external-lms/courses/{course_id}
PATCH/api/external-lms/courses/{course_id}
DELETE/api/external-lms/courses/{course_id}

scorm-taking 4 endpoints

GET/api/scorm-courses/available
POST/api/scorm-courses/{course_id}/attempts
PUT/api/scorm-attempts/{attempt_id}
GET/api/scorm-content/{ticket}/{asset_path}

scorm 12 endpoints

GET/api/scorm-courses/{course_id}/attempts
POST/api/scorm-courses/uploads
GET/api/scorm-courses
POST/api/scorm-courses
PUT/api/scorm-courses/{course_id}/subjects
POST/api/scorm-courses/{course_id}/package-uploads
PUT/api/scorm-courses/{course_id}/package
GET/api/scorm-courses/{course_id}/package-versions
GET/api/scorm-courses/{course_id}/permanent-deletion
DELETE/api/scorm-courses/{course_id}/permanent-deletion
GET/api/scorm-courses/{course_id}
PATCH/api/scorm-courses/{course_id}

job-aids 20 endpoints

GET/api/job-aids/available
GET/api/job-aids
POST/api/job-aids
GET/api/job-aids/{job_aid_id}/attachments/{attachment_id}/download
PUT/api/job-aids/{job_aid_id}/attachments/{attachment_id}/file
POST/api/job-aids/{job_aid_id}/attachment-uploads
POST/api/job-aids/{job_aid_id}/attachments
PATCH/api/job-aids/{job_aid_id}/attachments/{attachment_id}
DELETE/api/job-aids/{job_aid_id}/attachments/{attachment_id}
POST/api/job-aids/{job_aid_id}/links
PATCH/api/job-aids/{job_aid_id}/links/{link_id}
DELETE/api/job-aids/{job_aid_id}/links/{link_id}
PUT/api/job-aids/{job_aid_id}/subjects
POST/api/job-aids/{job_aid_id}/views
GET/api/job-aids/{job_aid_id}/analytics
GET/api/job-aids/{job_aid_id}/permanent-deletion
DELETE/api/job-aids/{job_aid_id}/permanent-deletion
POST/api/job-aids/{job_aid_id}/duplicate
GET/api/job-aids/{job_aid_id}
PATCH/api/job-aids/{job_aid_id}

qr-codes 9 endpoints

GET/api/qr-codes
POST/api/qr-codes
PUT/api/qr-codes/{qr_code_id}/target
GET/api/qr-codes/{qr_code_id}/target-changes
GET/api/qr-codes/{qr_code_id}/analytics
GET/api/qr-codes/{qr_code_id}/permanent-deletion
DELETE/api/qr-codes/{qr_code_id}/permanent-deletion
GET/api/qr-codes/{qr_code_id}
PATCH/api/qr-codes/{qr_code_id}

events 17 endpoints

GET/api/events/mine
POST/api/events/batch
POST/api/events/conflicts
GET/api/events
POST/api/events
GET/api/events/{event_id}/permanent-deletion
DELETE/api/events/{event_id}/permanent-deletion
POST/api/events/{event_id}/duplicate
GET/api/events/{event_id}
PATCH/api/events/{event_id}
PUT/api/events/{event_id}/subjects
GET/api/events/{event_id}/participants
POST/api/events/{event_id}/participants
DELETE/api/events/{event_id}/participants/{user_id}
PUT/api/events/{event_id}/participants/{user_id}/attendance
POST/api/events/{event_id}/trainers
DELETE/api/events/{event_id}/trainers/{user_id}

forums 14 endpoints

GET/api/forums
POST/api/forums
GET/api/forums/{forum_id}/topics
POST/api/forums/{forum_id}/topics
GET/api/forums/{forum_id}
PATCH/api/forums/{forum_id}
DELETE/api/forums/{forum_id}
PATCH/api/forum-topics/{topic_id}/moderation
POST/api/forum-topics/{topic_id}/replies
GET/api/forum-topics/{topic_id}
PATCH/api/forum-topics/{topic_id}
DELETE/api/forum-topics/{topic_id}
PATCH/api/forum-replies/{reply_id}
DELETE/api/forum-replies/{reply_id}

notifications 5 endpoints

POST/api/notifications/certification-requirements
GET/api/notifications/schedule
PATCH/api/notifications/schedule
GET/api/notifications/schedule/tick
POST/api/notifications/schedule/run

branding 5 endpoints

GET/api/branding
PATCH/api/branding
GET/api/branding/logo
POST/api/branding/logo
DELETE/api/branding/logo

feature-flags 2 endpoints

GET/api/feature-flags
PATCH/api/feature-flags

search 1 endpoint

GET/api/search

ai-search 3 endpoints

GET/api/ai-search
GET/api/ai-search/index/tick
POST/api/ai-search/index/run

Botree Learning Record Storage

Home Trainee Dashboard API documentation botreeinc.com