Account endpoints
All 11 endpoints for running the organizations on your account by script: list the organizations a key reaches, and add, change and remove members and team members. An API key with member scopes, created by an Owner or IT person under Settings → Account → API keys, calls them; they answer 403 with code: accounts_not_enabled until BloomText turns accounts on for your account.
https://api.bloomtext.com/v1Pass org_id to say which organization a call is for when the key reaches more than one; without it the call answers 400 with code: org_id_required. List organizations returns the IDs. An API key changes only the memberships an API key made: the rest answer 409 with code: managed_by_admin, managed_by_account, or managed_by_identity_provider (the account’s Okta rules).
Organizations
The organizations on your account an account API key reaches.
| Method | Path | Endpoint | Scope |
|---|---|---|---|
| GET | /orgs | List organizations | members.read |
Members
People in an organization on your account, and who manages each membership.
| Method | Path | Endpoint | Scope |
|---|---|---|---|
| GET | /members | List members | members.read |
| POST | /members | Add a member | members.write |
| GET | /members/{memberId} | Retrieve a member | members.read |
| PATCH | /members/{memberId} | Update a member | members.write |
| DELETE | /members/{memberId} | Remove a member | members.write |
Teams
Teams in an organization on your account, and the people the API placed on them.
| Method | Path | Endpoint | Scope |
|---|---|---|---|
| GET | /teams | List teams | members.read |
| POST | /teams/{teamId}/members | Add a member to a team | teams.write |
| DELETE | /teams/{teamId}/members/{memberId} | Remove a member from a team | teams.write |
Member events
Who joined, was approved, or left an organization on your account, and who did it.
| Method | Path | Endpoint | Scope |
|---|---|---|---|
| GET | /member-events | List member events | members.read |
Audit events
What people did in an organization on your account: sign-ins, chat views, exports, member and setting changes. Kept six years.
| Method | Path | Endpoint | Scope |
|---|---|---|---|
| GET | /audit-events | List audit events | audit.read |