Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
Settings API
Everything that shows up under the dashboard’s Settings tab — the organization profile, user preferences, in-app notifications, team & invites, API keys, and sender IDs.
Base path: /v1/settings
Authentication: Session JWT (most operations are admin/owner-gated).
Organization
| Method | Path | Purpose |
|---|
GET | /v1/settings/organization | Read org profile |
GET | /v1/settings/general | General settings |
PUT | /v1/settings/general | Update general settings |
User preferences
| Method | Path | Purpose |
|---|
GET | /v1/settings/preferences | Read the calling user’s preferences |
PUT | /v1/settings/preferences | Update preferences (theme, language, timezone) |
Notifications
| Method | Path | Purpose |
|---|
GET | /v1/settings/notifications | List unread notifications |
DELETE | /v1/settings/notifications | Mark all as read |
PUT | /v1/settings/notifications/{id}/read | Mark one as read |
Team
| Method | Path | Purpose |
|---|
GET | /v1/settings/team | List team members |
GET | /v1/settings/team/activity | Recent team activity |
POST | /v1/settings/team/invite | Invite a new member |
PUT | /v1/settings/team/{userId} | Change role |
DELETE | /v1/settings/team/{userId} | Remove a member |
GET | /v1/settings/team/invites | List pending invites |
DELETE | /v1/settings/team/invites/{email} | Cancel an invite |
POST | /v1/settings/team/invites/{email}/resend | Resend an invite |
POST | /v1/settings/team/accept-invite | Accept an invite (invited user calls this) |
API keys
| Method | Path | Purpose |
|---|
GET | /v1/settings/api-keys | List API keys |
POST | /v1/settings/api-keys | Issue a new API key |
DELETE | /v1/settings/api-keys/{id} | Revoke immediately |
POST | /v1/settings/api-keys/{id}/rotate | Rotate (issues new + revokes old) |
POST | /v1/settings/api-keys/{id}/schedule-revoke | Schedule revocation in the future (for safe rotation) |
POST | /v1/settings/api-keys/{id}/cancel-revoke | Cancel a scheduled revoke |
Sender IDs
| Method | Path | Purpose |
|---|
GET | /v1/settings/sender-ids | List sender IDs |
POST | /v1/settings/sender-ids | Register a new sender ID |
See also
