v0.0.1
OAS 3.0.0
API documentation
Client Libraries
Status
Check API health and availability.
Status Operations
Get API Status
Returns the status of the backend.
Use Cases:
- Check if the service is running
- Confirm your API key is correct
Considerations:
- Can also check the status page for incident history
Responses
- application/json
Request Example forGET/public/healthCheck
curl https://api.edume.com/public/healthCheck \
--header 'X-Api-Key: YOUR_SECRET_TOKEN'
{
"status": "ok"
}Users (Collapsed)
Manage learner profiles and associated data, including identifiers, teams, and tags.
Users Operations
- GET/public/users
- GET/public/users/{userId}/identifiers
- POST/public/users/{userId}/identifiers
- POST/public/team/{teamId}/user
- PUT/public/users/{userId}
- DELETE/public/users/{userId}
- PUT/public/users/{userId}/teams
- PATCH/public/users/{userId}/teams
- PUT/public/users/{userId}/identifiers/{identifierId}
- DELETE/public/users/{userId}/identifiers/{identifierId}
- PATCH/public/users/{userId}/tags