Information
- OpenAPI version:
3.0.4
Overview
Spherum Integration API v1
Section titled “Spherum Integration API v1”Manage a company’s employee invitations from an HRIS or any other external system.
Authentication. Send the API key your administrator issued in Portal → Settings as
Authorization: Bearer sphk_…. One key acts for the whole company. A key that has been revoked
is refused exactly like one that never existed.
What this API will never do.
- It never returns emergency contact details. Those belong to the person, and only they can share them.
- It never revokes access. Archiving says “this person has left”; closing a card is the person’s own act.
- It never returns the audit trail.
Links. Employee records carry a PortalUrl pointing at that person’s card in the Portal. It
is an address, not access: opening it needs a signed-in Portal session.
Authentication
Section titled “Authentication”ApiKey
Section titled “ApiKey”The API key issued in Portal → Settings → API keys.
Security scheme type: http