# Sodium API: guide for AI agents Someone at an accountancy practice has given you a Sodium API key so you can work with their practice's data directly. Sodium is practice management software for UK accountants and bookkeepers. Read this whole file before your first call. It is written for you, the agent; the person who gave you the key has read a shorter version on https://sodiumhq.com/features/mcp/api-access Your user works at the practice. They are not one of its clients. In Sodium, "clients" are the businesses and individuals the practice does work for: accounts, tax, payroll, bookkeeping. ## This key is powerful. Work carefully. The key acts with the permissions of the role it was given. A key that was not limited to a role can do everything the person who made it can do: delete clients, email clients, change practice settings. Mistakes here land in a live practice's records and in its clients' inboxes. So: 1. Read before you write. Use GET calls to understand the records before you change any of them. 2. Never call a DELETE endpoint, or a bulk endpoint (a PATCH on a whole collection, or anything named "bulk"), unless the user has confirmed that exact action in this conversation. Show them what will be deleted or changed first. Treat every delete as permanent. 3. Never send anything to a client without the user's explicit go-ahead for that send: an email, a text or WhatsApp message, a proposal, an engagement letter, an information or document request, a questionnaire, a portal invitation. Where an endpoint can save a draft, save a draft and let the user send it. 4. Before changing many records, change one, show the user the result, and get their go-ahead for the rest. Say how many records the change will touch before you start. 5. Leave users, roles, security settings, subscription and billing endpoints alone unless the user asks for that specific change. 6. Keep the key secret, and out of the chat. Get it the way "Getting the key" below explains. Never print it, repeat it back, put it in a log, or write it into code or any file other than the one the user pastes it into. 7. A 403 means the key's role does not allow that call. Tell the user what you were trying to do. Do not look for another endpoint that gets round it. 8. When you are not sure what an endpoint or a field will do, stop and ask. 9. When the job is finished, delete the key file you made, and remind the user to delete the key in Sodium (https://app.sodiumhq.com/profile, API Keys tab). A key keeps working until it is deleted. ## Basics - Base URL: https://api.sodiumhq.com - Authentication: send the header `x-api-key: ` on every request. - Requests and responses are JSON (`Content-Type: application/json`). - Almost every path starts `/tenants/{tenant}/`. The tenant is the practice's code. You get it from the connection check below, so don't ask the user for it. - Records are identified by string codes (client code, task code, user code), not numeric ids. Take them from the `code` fields that list and get calls return. - Dates are ISO 8601: `2026-04-05` for a date, `2026-04-05T09:30:00Z` for a date and time. ## Getting the key Your user is probably not technical, and may not have read anything before pasting the prompt. If they haven't created a key yet, send them to https://app.sodiumhq.com/profile and the API Keys tab there, and suggest they: - name it after the job; - limit it to a role: Viewer if the job only needs to read, or a role with only the areas the job needs; - switch on Block send, unless the job is sending emails or messages; - copy the key when it appears. Don't ask them to paste the key into the chat: chats are kept, and often synced or shared. Give them a private place to put it instead. If you can run commands on the user's computer: 1. Create an empty file in their home folder, outside any project or repository: `~/.sodium-api-key` on Mac or Linux (`chmod 600` it), `%USERPROFILE%\.sodium-api-key` on Windows. 2. Open it for them in a plain text editor (`open -e` on a Mac, `notepad` on Windows), and ask them to paste the key in, save and close it, then tell you when they're done. 3. Read the key from that file each time you need it, without printing it. For example: `curl -s https://api.sodiumhq.com/tenants -H "x-api-key: $(cat ~/.sodium-api-key)"` In code, read the file (or an environment variable you set from it) rather than copying the key into the code. If you can't run commands (a chat-only assistant), there is no private way for you to take the key. Say so plainly. Suggest the Sodium MCP connector instead (https://sodiumhq.com/features/mcp), or an assistant that can run commands, such as Claude Code. If the user still wants to go ahead in the chat, that's their decision: remind them to delete the key as soon as the job is done. ## Connect first Once you have the key, check it works and find the practice: curl -s https://api.sodiumhq.com/tenants -H "x-api-key: $(cat ~/.sodium-api-key)" - It returns the practices the key can reach, each with a `code` and a `name`. A key limited to a role reaches one practice. - One practice: use its `code` as {tenant} from now on. - More than one: show the user the names and ask which one to work in. - Then tell the user in plain words that you're connected, naming the practice, and ask what they'd like done. Make sure you understand the job before you change anything. - If the call fails, say so plainly: a 401 usually means the key was copied wrongly or has been deleted (ask them to paste it into the file again), and a 403 that the practice has switched API keys off. Don't guess at a fix. Talk to the user in plain English throughout: describe what you'll do to their records ("update the manager on 40 clients"), not which endpoints you'll call. ## Lists and paging List endpoints take `offset` and `limit` (at most 50) and return: { "data": [...], "totalCount": 312, "offset": 0, "limit": 50, "hasMore": true } Keep asking with `offset` increased by `limit` while `hasMore` is true. Most lists also take `search`, `sortBy`, `sortDesc` and their own filters: use a filter rather than reading everything and filtering yourself. ## Creating and changing records - POST creates a record and returns it. - PUT replaces a record's editable fields. GET the record first, change only what you need, and send back every field in the update request. A field you leave out may be cleared. - PATCH is used for partial and bulk updates; read its description for what it changes. - DELETE removes a record. See rule 2. - Fixed lists of values (client types, statuses, service frequencies and so on) come from the `/metadata/...` endpoints, listed under Metadata below. Look a value up there rather than guessing it. ## Errors - 400: the request was invalid. The body is a problem details object; validation failures carry an `errors` object mapping each field to its messages. Fix the request and try again. - 401: the key is missing, wrong or deleted. - 403: the key's role does not allow this call, the key is blocked from sending, or the practice has switched API keys off. The `detail` field says which. - 404: no record with that code in this practice. - 429: too many requests. A key may make 200 requests a minute (metadata calls don't count). Requests over the limit are not queued: wait for the next minute and send again. Spread big jobs out rather than sending them in one burst. Keys cannot create, change or delete API keys, so don't try. ## Finding the right endpoint Each area below has its own plain-text file listing every endpoint in it: method, path, what it does, which permission it needs, its parameters and its request fields. Fetch only the areas your task needs. The full OpenAPI specification is at https://api.sodiumhq.com/swagger/v1/swagger.json (it is large: if you can run code, download it once to a file and query it rather than reading it whole). Human-readable docs for every endpoint start at https://sodiumhq.com/docs/api/operations ## Areas - Agent Authorisations (7 endpoints): https://sodiumhq.com/docs/api/agent/agent-authorisations.txt The practice-wide view of which clients need HMRC agent authorisations and what is held against each. - AI (5 endpoints): https://sodiumhq.com/docs/api/agent/ai.txt AI-powered features for content generation and usage tracking. - Announcements (1 endpoint): https://sodiumhq.com/docs/api/agent/announcements.txt The currently active platform announcement banner. - Broadcasts (1 endpoint): https://sodiumhq.com/docs/api/agent/broadcasts.txt Bulk Comms: the practice's bulk emails and bulk texts in one list, newest first, filterable by status and channel. - Budgets (15 endpoints): https://sodiumhq.com/docs/api/agent/budgets.txt Job budgets: the standard hours and fee budget on a service, how a client's service differs from it (follow it, adjust it by a percentage, or figures of its own), and progress against them per billing period. - Calendar Feed (3 endpoints): https://sodiumhq.com/docs/api/agent/calendar-feed.txt Per-user iCalendar (.ics) subscription feeds. - Calendar Subscriptions (7 endpoints): https://sodiumhq.com/docs/api/agent/calendar-subscriptions.txt External calendars subscribed to by ICS URL — the inbound mirror of Calendar Feed. - Charity Commission (4 endpoints): https://sodiumhq.com/docs/api/agent/charity-commission.txt Read-only lookups against the Charity Commission for England and Wales register. - Client - Agent Authorisations (10 endpoints): https://sodiumhq.com/docs/api/agent/client-agent-authorisations.txt Manage HMRC 64-8 agent authorisation statuses for individual clients. - Client - Billing - Lines (8 endpoints): https://sodiumhq.com/docs/api/agent/client-billing-lines.txt Billable line items promoted from the client's billing schedule. - Client - Billing - Schedule (7 endpoints): https://sodiumhq.com/docs/api/agent/client-billing-schedule.txt A client's billing schedule: every charge Sodium plans to raise for the client, past and future, one row per occurrence. - Client - Billing - Submissions (7 endpoints): https://sodiumhq.com/docs/api/agent/client-billing-submissions.txt Invoice submissions represent batches of approved billable line items pushed to the connected accounting platform. - Client - Books (22 endpoints): https://sodiumhq.com/docs/api/agent/client-books.txt A client's OWN accounting software: the organisation their record is bound to, and the invoices, contacts, bank accounts and profit and loss inside it. - Client - Business Details (3 endpoints): https://sodiumhq.com/docs/api/agent/client-business-details.txt Manage business-specific information for clients that are businesses (non-companies). - Client - Confirmations (1 endpoint): https://sodiumhq.com/docs/api/agent/client-confirmations.txt Tenant-wide list of client confirmation workflow steps. - Client - Contacts (5 endpoints): https://sodiumhq.com/docs/api/agent/client-contacts.txt Manage contacts associated with specific clients. - Client - Custom Fields (2 endpoints): https://sodiumhq.com/docs/api/agent/client-custom-fields.txt Manage custom field values for individual clients. - Client - Dates (3 endpoints): https://sodiumhq.com/docs/api/agent/client-dates.txt Manage key dates for individual clients including year-end, tax deadlines, and other compliance-related dates. - Client - Document Requests (28 endpoints): https://sodiumhq.com/docs/api/agent/client-document-requests.txt Manage document requests for clients. - Client - Documents (33 endpoints): https://sodiumhq.com/docs/api/agent/client-documents.txt Manage documents associated with specific clients. - Client - Email Rules (5 endpoints): https://sodiumhq.com/docs/api/agent/client-email-rules.txt Rules that associate emails with a client. - Client - Emails (2 endpoints): https://sodiumhq.com/docs/api/agent/client-emails.txt Returns emails associated with a client based on its configured rules. - Client - Links (5 endpoints): https://sodiumhq.com/docs/api/agent/client-links.txt Manage external links associated with specific clients. - Client - Meeting Notes (5 endpoints): https://sodiumhq.com/docs/api/agent/client-meeting-notes.txt Records of meetings and calls with a client: title, start and end time, how it took place, the contacts and staff who attended, a summary, the full content (usually a transcript), links such as the recording, and optionally the task it was about. - Client - MTD Adjustable Summaries (4 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-adjustable-summaries.txt Business source adjustable summaries (BSAS) for a client's MTD Income Tax income sources — HMRC's accounting result for a period, which the practice reviews and adjusts before the tax return. - Client - MTD Annual Submissions (3 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-annual-submissions.txt Year-end adjustments, allowances and non-financial declarations for a client's MTD Income Tax income sources. - Client - MTD Capital Gains (7 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-capital-gains.txt A client's capital gains for a tax year under MTD Income Tax, across HMRC's two resources: everything other than UK residential property (listed and unlisted shares, crypto-assets, other assets), and UK residential property disposals reported for Self Assessment. - Client - MTD Dividends (7 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-dividends.txt A client's dividend income for a tax year under MTD Income Tax: foreign and special dividends, plain UK dividends, and the directorship information HMRC require where the client is a director of a close company. - Client - MTD Employments (15 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-employments.txt A client's employment income for a tax year under MTD Income Tax: the employments themselves, the financial details held against each, and the income belonging to no single employment (non-PAYE tips, share schemes, lump sums, deductions). - Client - MTD Foreign Properties (3 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-foreign-properties.txt HMRC's register of a client's foreign properties, which exists from tax year 2026-27 onwards. - Client - MTD Income Sources (5 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-income-sources.txt Detail and per-tax-year settings for a client's MTD income sources — the accounting basis, the periods of account, and the late accounting date rule election. - Client - MTD ITSA Status (1 endpoint): https://sodiumhq.com/docs/api/agent/client-mtd-itsa-status.txt A client's Income Tax Self Assessment status with HMRC for a tax year: whether they are mandated into MTD, volunteered, exempt, on annual filing or dormant. - Client - MTD Losses (10 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-losses.txt A client's losses and loss claims under MTD Income Tax, across HMRC's two shapes. - Client - MTD Nominal Mappings (5 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-nominal-mappings.txt Mapping a client's chart of accounts to the boxes of an MTD Income Tax quarterly update, per income source, and pulling the cumulative period's figures from their connected books into a draft for review. - Client - MTD Quarterly Updates (7 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-quarterly-updates.txt Prepare and submit Making Tax Digital for Income Tax quarterly updates for a client's income sources. - Client - MTD Reliefs (10 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-reliefs.txt A client's reliefs for a tax year under MTD Income Tax: investment (VCT, EIS, SEIS, community investment), other reliefs (loan interest, maintenance payments, post-cessation losses), foreign tax reliefs, pension contributions and charitable giving. - Client - MTD Savings (5 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-savings.txt A client's savings income for a tax year under MTD Income Tax: the interest reported against each named UK savings account, and the other savings income that belongs to no account (securities interest, foreign interest). - Client - MTD Tax Liability Adjustments (3 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-tax-liability-adjustments.txt A client's tax liability adjustments for a tax year under MTD Income Tax: what a carry-back loss claim is worth against the year's bill, and tax already refunded or set off. - Client - MTD Tax Return (5 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-tax-return.txt Reviewing a client's Making Tax Digital Income Tax year and sending their tax return to HMRC. - Client - MTD Tax Year (4 endpoints): https://sodiumhq.com/docs/api/agent/client-mtd-tax-year.txt A client's Making Tax Digital position for one tax year, assembled from the HMRC resources behind it: the income sources with their quarterly update deadlines and the year's tax return deadline, one source's reporting setup, and everything HMRC hold outside the client's trading income. - Client - Notes (9 endpoints): https://sodiumhq.com/docs/api/agent/client-notes.txt Manage notes associated with specific clients. - Client - Open Work (2 endpoints): https://sodiumhq.com/docs/api/agent/client-open-work.txt Move a client's open work to a role's new holder. - Client - Pipelines (9 endpoints): https://sodiumhq.com/docs/api/agent/client-pipelines.txt Manage a client's placements on sales pipelines (kanban cards). - Client - Recurring Task Schedules (4 endpoints): https://sodiumhq.com/docs/api/agent/client-recurring-task-schedules.txt One client's schedule links on recurring tasks. - Client - Request & Chasing (2 endpoints): https://sodiumhq.com/docs/api/agent/client-request-chasing.txt Settings for client request email templates and automated chasing frequencies. - Client - Services (10 endpoints): https://sodiumhq.com/docs/api/agent/client-services.txt Manage billable services associated with specific clients. - Client - Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/client-settings.txt Tenant-level configuration for client field visibility and behavior. - Client - Sodium Products (8 endpoints): https://sodiumhq.com/docs/api/agent/client-sodium-products.txt A client's accounts in other Sodium products, such as its CIS Manager organisation. - Client Billable Services (2 endpoints): https://sodiumhq.com/docs/api/agent/client-billable-services.txt Top-level client billable service queries not scoped to a single client. - Client Billing - Line Items (1 endpoint): https://sodiumhq.com/docs/api/agent/client-billing-line-items.txt Tenant-wide view of billing line items across all clients. - Client Billing - Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/client-billing-settings.txt Tenant-level settings for recurring client billing and invoicing defaults. - Client Portal - Access (3 endpoints): https://sodiumhq.com/docs/api/agent/client-portal-access.txt Manage portal access for client contacts. - Client Portal - Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/client-portal-settings.txt Tenant-level settings for the client portal. - Client Portal - Users (3 endpoints): https://sodiumhq.com/docs/api/agent/client-portal-users.txt Manage portal user accounts across the tenant. - Clients (12 endpoints): https://sodiumhq.com/docs/api/agent/clients.txt Comprehensive client management including CRUD operations and task summaries. - Clients - Companies House Enrichment (2 endpoints): https://sodiumhq.com/docs/api/agent/clients-companies-house-enrichment.txt Enrich clients the practice already holds from Companies House, for the clients a user selected. - Clients - CSV Export (2 endpoints): https://sodiumhq.com/docs/api/agent/clients-csv-export.txt CSV-based client export with flexible column mapping. - Clients - CSV Import (3 endpoints): https://sodiumhq.com/docs/api/agent/clients-csv-import.txt CSV-based client import with flexible column mapping. - Clients - Platform Import (3 endpoints): https://sodiumhq.com/docs/api/agent/clients-platform-import.txt Import clients from third-party platforms (e.g., Xero, QuickBooks) or via direct import with comprehensive data. - Clients - Saved Filters (7 endpoints): https://sodiumhq.com/docs/api/agent/clients-saved-filters.txt Saved client filter management for personalized client views. - Clients - Services - Import (6 endpoints): https://sodiumhq.com/docs/api/agent/clients-services-import.txt CSV-based client service import for bulk-assigning billable services to clients. - Companies House (8 endpoints): https://sodiumhq.com/docs/api/agent/companies-house.txt Integration with UK Companies House API for retrieving official company information. - Contacts (10 endpoints): https://sodiumhq.com/docs/api/agent/contacts.txt Organization-wide contact management across all clients. - Contacts - CSV Export (2 endpoints): https://sodiumhq.com/docs/api/agent/contacts-csv-export.txt Export every contact in the practice to CSV, one row per client link, in the same columns the contacts import reads. - Content Blocks (14 endpoints): https://sodiumhq.com/docs/api/agent/content-blocks.txt Reusable content blocks for documents and proposals. - CSV Mappings (5 endpoints): https://sodiumhq.com/docs/api/agent/csv-mappings.txt Manage reusable CSV column mappings for client import and export operations. - Custom Field - Groups (5 endpoints): https://sodiumhq.com/docs/api/agent/custom-field-groups.txt Named groups for organising custom field definitions. - Custom Fields (5 endpoints): https://sodiumhq.com/docs/api/agent/custom-fields.txt Tenant-level custom field definitions for extending entity data. - Custom Tokens (5 endpoints): https://sodiumhq.com/docs/api/agent/custom-tokens.txt User-defined reusable tokens for document templates. - Dashboard Links (6 endpoints): https://sodiumhq.com/docs/api/agent/dashboard-links.txt Links saved on the dashboard, each with an optional title and in an order the user sets. - Data Form - Categories (5 endpoints): https://sodiumhq.com/docs/api/agent/data-form-categories.txt Tenant-configurable categories for organizing forms. - Data Form - Requests (12 endpoints): https://sodiumhq.com/docs/api/agent/data-form-requests.txt Form requests sent to clients. - Data Forms (16 endpoints): https://sodiumhq.com/docs/api/agent/data-forms.txt Custom form management. - Design Theme - Background Images (4 endpoints): https://sodiumhq.com/docs/api/agent/design-theme-background-images.txt Manage background images on design themes for PDF rendering. - Design Themes (8 endpoints): https://sodiumhq.com/docs/api/agent/design-themes.txt Design themes and branding customization for documents and proposals. - DirectDebit (7 endpoints): https://sodiumhq.com/docs/api/agent/directdebit.txt Integration with third-party direct debit platforms. - Document - Templates (12 endpoints): https://sodiumhq.com/docs/api/agent/document-templates.txt Document templates using Liquid syntax for dynamic content generation. - Document Requests (1 endpoint): https://sodiumhq.com/docs/api/agent/document-requests.txt Tenant-wide list of document requests. - Document Requests - Saved Lists (5 endpoints): https://sodiumhq.com/docs/api/agent/document-requests-saved-lists.txt A practice's saved lists of document request items (kind and text), e.g. - Documents - Categories (5 endpoints): https://sodiumhq.com/docs/api/agent/documents-categories.txt Tenant-configurable document categories for organizing client documents. - Email - Broadcasts (13 endpoints): https://sodiumhq.com/docs/api/agent/email-broadcasts.txt Ad-hoc mass emails to a filtered set of clients with per-client Liquid token rendering. - Email - Configs (16 endpoints): https://sodiumhq.com/docs/api/agent/email-configs.txt Email configuration management for tenant-specific SMTP or OAuth email providers. - Email - History (2 endpoints): https://sodiumhq.com/docs/api/agent/email-history.txt Email history and delivery status tracking. - Email - Mailbox (23 endpoints): https://sodiumhq.com/docs/api/agent/email-mailbox.txt Read, send, reply to, and manage emails in a tenant's connected mailbox. - Email - Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/email-settings.txt Email configuration and settings for tenant email communications. - Email - Triage (31 endpoints): https://sodiumhq.com/docs/api/agent/email-triage.txt Email triage for connected mailboxes: the practice's editable conversation statuses (which ones mean Done, and whether Done archives the email), each mailbox's triage settings (switched on, default status, default assignee), the people who can be assigned a mailbox's conversations, the status and assignee of many conversations in one change, internal comments with @mentions on a conversation, a summary of a conversation written by hand or by the AI (shown with its triage state), the addresses and domains marked as not a client, and a lookup that classifies addresses as a client's, not a client, the practice's own or unknown. - Engagement - Acceptance (1 endpoint): https://sodiumhq.com/docs/api/agent/engagement-acceptance.txt Anonymous client-facing endpoints for engagement acceptance workflow. - Engagement - Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/engagement-settings.txt Settings and configuration specific to engagement generation and management. - Engagements (17 endpoints): https://sodiumhq.com/docs/api/agent/engagements.txt Comprehensive engagement creation, management, and client communication. - External Proposals (4 endpoints): https://sodiumhq.com/docs/api/agent/external-proposals.txt Read-only access to proposals from external proposal platforms (e.g., Socket). - Filing Credits (5 endpoints): https://sodiumhq.com/docs/api/agent/filing-credits.txt The practice's prepaid filing credit balance. - HMRC Agent Credentials (7 endpoints): https://sodiumhq.com/docs/api/agent/hmrc-agent-credentials.txt The practice's sets of HMRC agent details: a Government Gateway login with the ARN, agent codes and agent contact that go with it. - HMRC Connection (3 endpoints): https://sodiumhq.com/docs/api/agent/hmrc-connection.txt The practice's HMRC connection, used for digital (Making Tax Digital) agent authorisations. - Holidays (5 endpoints): https://sodiumhq.com/docs/api/agent/holidays.txt Tenant-specific custom holidays (e.g., company anniversary, office closure dates). - Import Jobs (3 endpoints): https://sodiumhq.com/docs/api/agent/import-jobs.txt Asynchronous import job status tracking and management. - Integrations - Accounting (6 endpoints): https://sodiumhq.com/docs/api/agent/integrations-accounting.txt Integration with third-party accounting platforms. - Integrations - AML (14 endpoints): https://sodiumhq.com/docs/api/agent/integrations-aml.txt Integration with third-party Anti-Money Laundering platforms. - Making Tax Digital (4 endpoints): https://sodiumhq.com/docs/api/agent/making-tax-digital.txt Confirming with HMRC which clients the practice is currently authorised to act for under Making Tax Digital. - Media Library - Documents (6 endpoints): https://sodiumhq.com/docs/api/agent/media-library-documents.txt Practice document library — static files (guides, checklists, terms PDFs). - Media Library - Images (6 endpoints): https://sodiumhq.com/docs/api/agent/media-library-images.txt Image asset management for pictures used in emails, documents, and design themes. - Meeting Notes - Unmatched (3 endpoints): https://sodiumhq.com/docs/api/agent/meeting-notes-unmatched.txt Meeting notes imported from a note taker (Granola) that are not on any client's Meetings tab: their attendees matched no client, or more than one. - Messaging (54 endpoints): https://sodiumhq.com/docs/api/agent/messaging.txt The practice's SMS and WhatsApp messaging with clients and contacts, through the shared Messaging Service. - Metadata (105 endpoints): https://sodiumhq.com/docs/api/agent/metadata.txt System metadata including enums, display names, colors, icons, and configuration options for all system enums. - Notifications (13 endpoints): https://sodiumhq.com/docs/api/agent/notifications.txt The signed-in user's in-app notifications: work assigned to them (tasks and workflow steps) and client responses they were waiting for. - Outbound Webhooks (10 endpoints): https://sodiumhq.com/docs/api/agent/outbound-webhooks.txt The practice's webhooks: its own HTTPS URLs that receive a signed POST (Standard Webhooks) when a client is created, updated or archived, or a task is created or completed. - Pinned Notes (1 endpoint): https://sodiumhq.com/docs/api/agent/pinned-notes.txt Cross-entity read of the client and task notes pinned to the dashboard (PinnedLevel 3). - Pipeline - Intake Tasks (6 endpoints): https://sodiumhq.com/docs/api/agent/pipeline-intake-tasks.txt Templates for intake tasks that are created automatically when a client (typically an Active Prospect) is added to a pipeline. - Pipelines (10 endpoints): https://sodiumhq.com/docs/api/agent/pipelines.txt Tenant-level sales pipeline catalog management. - Practice (2 endpoints): https://sodiumhq.com/docs/api/agent/practice.txt Practice-level settings and configuration for the tenant. - Practice Note (2 endpoints): https://sodiumhq.com/docs/api/agent/practice-note.txt The practice's single shared free-text note. - Professional Clearance (9 endpoints): https://sodiumhq.com/docs/api/agent/professional-clearance.txt Professional clearance letter management for client transitions. - Reports (29 endpoints): https://sodiumhq.com/docs/api/agent/reports.txt Curated, typed, read-only reports over the tenant's operational data. - Requests (1 endpoint): https://sodiumhq.com/docs/api/agent/requests.txt Cross-cutting summary of the Requests page: one outstanding count per tab (steps ready to send, pending scheduled sends, forms awaiting a response, document approvals pending, document requests open and submitted, open confirmations). - Revenue Ranges (5 endpoints): https://sodiumhq.com/docs/api/agent/revenue-ranges.txt Tenant-configurable revenue ranges for client classification and pricing. - Roles (6 endpoints): https://sodiumhq.com/docs/api/agent/roles.txt Custom (tenant-defined) roles granting per-entity capability sets. - Sales Pipeline - Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/sales-pipeline-settings.txt Tenant-level settings for the Sales Pipeline feature. - Scheduled Sends (5 endpoints): https://sodiumhq.com/docs/api/agent/scheduled-sends.txt Deferred outbound sends: emails, replies, workflow step sends, document requests, data forms, document approvals and broadcasts scheduled for a later dispatch time. - Security Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/security-settings.txt Tenant-level security settings. - Service - Categories (5 endpoints): https://sodiumhq.com/docs/api/agent/service-categories.txt Tenant-configurable categories for grouping billable services. - Service - Onboarding Tasks (6 endpoints): https://sodiumhq.com/docs/api/agent/service-onboarding-tasks.txt Templates for one-off tasks that are automatically created when a client takes on a billable service. - Service - Packages (8 endpoints): https://sodiumhq.com/docs/api/agent/service-packages.txt Service package management for bundling multiple billable services together. - Services (16 endpoints): https://sodiumhq.com/docs/api/agent/services.txt Tenant-level billable services catalog management. - Services - Import (3 endpoints): https://sodiumhq.com/docs/api/agent/services-import.txt CSV-based import and export of the billable services catalog. - Sodium Apps (4 endpoints): https://sodiumhq.com/docs/api/agent/sodium-apps.txt The practice's connections to the other Sodium products (Settings > Sodium Apps). - Subscription (6 endpoints): https://sodiumhq.com/docs/api/agent/subscription.txt Tenant subscription management. - Subscription - Billing (10 endpoints): https://sodiumhq.com/docs/api/agent/subscription-billing.txt Billing account management for tenant subscriptions. - Subscription - Discounts (3 endpoints): https://sodiumhq.com/docs/api/agent/subscription-discounts.txt Discount code management for tenant subscriptions. - Subscription - Packages (3 endpoints): https://sodiumhq.com/docs/api/agent/subscription-packages.txt Public endpoints for listing packages and their pricing tiers. - Task - Emails (1 endpoint): https://sodiumhq.com/docs/api/agent/task-emails.txt Returns email conversations that have been explicitly linked to a task. - Task - Notes (6 endpoints): https://sodiumhq.com/docs/api/agent/task-notes.txt Manage notes associated with specific tasks. - Task - Workflow Notes (6 endpoints): https://sodiumhq.com/docs/api/agent/task-workflow-notes.txt Manage notes associated with specific workflow steps within tasks. - Task - Workflows (20 endpoints): https://sodiumhq.com/docs/api/agent/task-workflows.txt Task workflow progress tracking and step management for individual tasks. - Tasks (13 endpoints): https://sodiumhq.com/docs/api/agent/tasks.txt Comprehensive task management including creation, assignment, tracking, and filtering. - Tasks - Categories (5 endpoints): https://sodiumhq.com/docs/api/agent/tasks-categories.txt Tenant-configurable task categories for organizing and classifying tasks. - Tasks - CSV Export (2 endpoints): https://sodiumhq.com/docs/api/agent/tasks-csv-export.txt - Tasks - Focus Config (2 endpoints): https://sodiumhq.com/docs/api/agent/tasks-focus-config.txt Per-user configuration for the Task Focus Panel sidebar. - Tasks - Import (4 endpoints): https://sodiumhq.com/docs/api/agent/tasks-import.txt Task CSV import and export. - Tasks - Projected (3 endpoints): https://sodiumhq.com/docs/api/agent/tasks-projected.txt Projected (virtual) task items generated from recurring tasks that haven't been materialized yet. - Tasks - Recurring (20 endpoints): https://sodiumhq.com/docs/api/agent/tasks-recurring.txt Recurring task templates and scheduling for automated task generation. - Tasks - Saved Filters (7 endpoints): https://sodiumhq.com/docs/api/agent/tasks-saved-filters.txt Saved task filter management for personalized task views. - Tasks - Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/tasks-settings.txt Practice-wide task settings. - Tasks - Templates (9 endpoints): https://sodiumhq.com/docs/api/agent/tasks-templates.txt One-off task templates: pre-defined task shapes (description, checklist, optional workflow, category, assignment rule, due-date offset) that users turn into real tasks for a chosen client on demand. - Tenants (5 endpoints): https://sodiumhq.com/docs/api/agent/tenants.txt Multi-tenant organization management and configuration. - Text Broadcasts (14 endpoints): https://sodiumhq.com/docs/api/agent/text-broadcasts.txt Bulk texts: one SMS to each chosen contact's mobile at a filtered set of clients, sent from the practice's own number, with per-client and per-recipient Liquid token rendering. - Third-Party Connections (22 endpoints): https://sodiumhq.com/docs/api/agent/third-party-connections.txt OAuth connections and integrations to third-party platforms (accounting systems, practice management tools, etc.). - Time Tracking (22 endpoints): https://sodiumhq.com/docs/api/agent/time-tracking.txt Time entries recorded by team members, optionally linked to a client and/or task. - Time Tracking - Import (2 endpoints): https://sodiumhq.com/docs/api/agent/time-tracking-import.txt Time entry CSV import for timesheets exported from other tools (Clockify, Toggl, spreadsheets). - Time Tracking - Rates (3 endpoints): https://sodiumhq.com/docs/api/agent/time-tracking-rates.txt The practice's charge-out and cost rates for a type of work — a task category or a service — kept as date-effective entries. - Time Tracking - Settings (2 endpoints): https://sodiumhq.com/docs/api/agent/time-tracking-settings.txt Tenant-level settings for time recording. - Time Tracking - Time Off (6 endpoints): https://sodiumhq.com/docs/api/agent/time-tracking-time-off.txt Team members' holiday, sickness and other leave, as date ranges of whole or part days. - Time Tracking - Timer (8 endpoints): https://sodiumhq.com/docs/api/agent/time-tracking-timer.txt The calling user's live timer — at most one per user. - Time Tracking - Working Patterns (5 endpoints): https://sodiumhq.com/docs/api/agent/time-tracking-working-patterns.txt Named working weeks team members can be put on — "Full time", "Part time (Mon/Wed/Fri)" — holding the minutes expected on each day. - Time Tracking - Write-off Reasons (5 endpoints): https://sodiumhq.com/docs/api/agent/time-tracking-write-off-reasons.txt Tenant-configurable reasons for writing time off (or on) against a fee: Quoted fixed fee, Overrun, Goodwill, Client dispute, Training / junior time, Other by default. - User - Account (6 endpoints): https://sodiumhq.com/docs/api/agent/user-account.txt User account management endpoints including retrieving unused invite codes for the authenticated user. - User - Invitations (3 endpoints): https://sodiumhq.com/docs/api/agent/user-invitations.txt User invitation workflow for adding users to tenants. - User - Notes (4 endpoints): https://sodiumhq.com/docs/api/agent/user-notes.txt The calling user's own free-text notes, private to them. - User - Teams (9 endpoints): https://sodiumhq.com/docs/api/agent/user-teams.txt Team management for group task assignment. - User - View Preferences (2 endpoints): https://sodiumhq.com/docs/api/agent/user-view-preferences.txt Per-user view preferences for storing UI configuration as JSON. - Users (20 endpoints): https://sodiumhq.com/docs/api/agent/users.txt User management and authentication within the application. - Webhooks (1 endpoint): https://sodiumhq.com/docs/api/agent/webhooks.txt Inbound webhook receipt from third-party platforms (e.g. - Workflow Steps - Pending (2 endpoints): https://sodiumhq.com/docs/api/agent/workflow-steps-pending.txt Manual-mode outbound workflow steps that are ready to send. - Workflows (13 endpoints): https://sodiumhq.com/docs/api/agent/workflows.txt Reusable workflow definitions and templates for task automation. - Working Days (3 endpoints): https://sodiumhq.com/docs/api/agent/working-days.txt Configure working days, holidays, and task scheduling adjustments.