Partner API · v1.0.1System status
Connect Beedeez to your stack
Sync your learners and pull their progress into the tools you run.
01 → 03
# 01 · secret from the Back Office
# 02 · exchange it for an access token
ACCESS_TOKEN=$(curl -s -X POST "$BEEDEEZ_API/v1/token" \
-H "Content-Type: application/json" \
-d "{ \"appSecret\": \"$BEEDEEZ_SECRET\" }" \
| jq -r .access_token)
# 03 · first call
curl "$BEEDEEZ_API/v1/users" \
-H "Authorization: Bearer $ACCESS_TOKEN"
01
Authentication & provisioning
Exchange your secret for JWT tokens, then find learners by email or external ID.
POST /token · GET /users
02
Sync users & groups
Mirror your org: find users by email or external ID, read their groups.
GET /users · GET /groups
03
Report completion
Pull lessons, tracks and answers into your BI or LMS.
GET /active-lessons · GET /answers
04
Webhooks & callbacks
Get notified when a learner earns a certificate, and report external lesson status back.
certificate_completed · POST /callbacks
API resources
Full referenceActivelessons
Lessons currently active
Answers
A user’s answers on a lesson
Authentification
Log users out
Callbacks
Lesson status updates
Category
Content categories
Groups
Groups of the current owner
Token
Issue JWT tokens
Lesson Session
Scheduled sessions
Lesson
Capsules in the app
Track
Learning tracks
Users
Learners of the account