VBASoftware API (v1)
VBAPI is the REST API for reading and writing your organization's VBASoftware data: employer groups, subscribers and members, plans and benefits, providers, claims, authorizations, premium billing, and accounting. This reference lists all 5,340 operations on 2,946 paths, in the 31 groups shown in the sidebar.
Most record types have list, get, create, update, delete, and batch operations. Advanced endpoints run VBASoftware business logic, such as adjudicating a claim queue; most of them are in the Advanced APIs group, under tags that start with Adv..
- Quick start: log in and list five groups in about five minutes, in C#, Python, or TypeScript.
- Credentials and environments: the values VBA issues and which header each one goes in.
- Authentication and tokens: log in once, reuse the ID token until it expires, and handle login challenges.
- Playbooks: end-to-end workflows with runnable code, such as onboarding an employer group or entering and adjudicating claims.
- AI assistant and MCP server: ask the docs assistant, or connect your own AI tools to these docs.
Clients use one host, the production API. Every call names the database it works in with the vbasoftware-database header. Because every call reaches production, write calls (POST, PUT, DELETE) change real records.
https://vbapi.vbasoftware.com/vbasoftwareLog in with POST /user-authentication. It returns the tokens in data.authenticationResult; expiresIn is the ID token's lifetime in seconds.
POST /user-authentication
x-api-key: <your API key>
Authorization: Basic <base64 of username:password>
vbasoftware-client-id: <your client ID>
vbasoftware-client-code: <your client code>
vbasoftware-database: YOUR_DATABASEEvery other call sends the ID token as a Bearer token:
GET /groups?page=1&pageSize=5
x-api-key: <your API key>
Authorization: Bearer <idToken>
vbasoftware-database: YOUR_DATABASE
User-Agent: YourCompany-Integration/1.0User-Agent is recommended, not required: a descriptive value lets VBA support find your calls in the logs.
- Responses use one envelope:
data,error, anddebug.activityID. Creates, gets, lists, and updates return200(not201), deletes return204, batch updates return207, and advanced operations that queue work return202. See Requests and responses. - Lists take
page(pages start at 1) andpageSize(default 100), and returnTotalCount,TotalPages,CurrentPage, andPageSizein theX-Paginationresponse header. Sort withsortBy, for examplegroup_ID:asc. See Pagination and sorting. - Errors put a problem-details object in
error; readdetailfirst. Log the activity ID with every failure (error bodies spell itdebug.ActivityID) and include it when you contact support. A missing or wrongx-api-keyreturns403with{"message":"Forbidden"}from the API gateway. See Errors and troubleshooting. - Rate limits are 25 requests per second sustained, with bursts of up to 50, per API key. Everything that uses the same key shares the allowance, and a request over the limit returns
429. See Rate limits and performance. - Search: one
POST /searchreturns chosen columns from related tables, up to 750 rows a page. See Search API.
Operation counts are per sidebar group. An operation with tags in more than one group is counted in each.
Business areas
| Area | What it covers | Operations |
|---|---|---|
| Group | Employer groups, divisions, contracts and contract plans, plan years, group networks | 391 |
| Enrollment | Subscribers, members, enrollments and enrollment plans, accumulators, ID card requests | 404 |
| Benefit | Plans, plan benefits, benefit categories, plan accumulators and maximums | 361 |
| Claim | Claims, claim batches, claim queues and adjudication, audits, claim invoices and payments | 587 |
| Auth | Authorizations (not login): auth codes, diagnosis and procedure codes, reviews, work logs | 119 |
| Provider | Providers, provider networks, rates, payees, per diems, taxonomy | 155 |
| Credentialing | Provider credentialing: licenses, certifications, attestations, contracts | 245 |
| FeeSchedule | Fee schedules, schedule details, modifier and provider type discounts | 50 |
| Billing | Premium invoices, payments, distributions, premium rates, past-due triggers | 276 |
| Accounting | Checks and check batches, funding requests and deposits, reconciliations, payor accounts | 225 |
| Capitation | Capitations, capitation services and plan rates, adjustments, transactions | 74 |
| Commission | Commission agencies and reps, rates, activity, adjustments, transactions | 179 |
| Reinsurance | Reinsurance contracts, levels, criteria, transactions, accumulators | 162 |
| CareManagement | Care cases, care plans, care managers and care units, intakes, treatments | 412 |
| Grievance | Grievances and their categories, issue, resolution, and status types | 44 |
| CallTracking | Call tracking records, call types, statuses, destinations | 47 |
| Note | Notes, note attachments, categories, references | 49 |
| Workflow | Workflows, workflow tasks and task users, workflow types | 48 |
| Report | Report definitions, report queues and schedules, report series, report tracking | 161 |
Platform and reference data
| Area | What it covers | Operations |
|---|---|---|
| Common | Shared code and lookup tables: diagnostic and procedure codes, HIPAA codes, states and ZIP codes, networks, contacts, search configuration | 953 |
| Advanced APIs | Business-logic operations under Adv. tags, such as claim refunds, premium invoice generation, and member or group disenrollment | 159 |
| Admin | Client configuration, company data, jobs, interface profiles, change data capture, IP allowlists | 167 |
| User | Login (POST /user-authentication), users and user groups, multi-factor authentication, password policy | 70 |
| Security | Security areas, field security, user and user group access | 96 |
| Event | Events, event arguments, event schedules | 34 |
| VBAGateway | VBAGateway subscriptions and subscription details | 12 |
| VBAReporting | VBA reports | 8 |
| Support | Support operations | 5 |
| ProcessAutomation | Process automation | 3 |
| Chat | VBAssist | 2 |
| Interop | Base load | 1 |
- Generate a client library from this description: Generate an SDK.
- Call operations from this reference without writing code: Try it in the browser.
- Questions, or something does not work as documented: Support and escalation.