Welcome

This portal is for developers at VBASoftware client organizations who build integrations with VBAPI. It takes you from receiving credentials to a working first call, and then to complete workflows you can copy into your own code.

1. Get your credentials. VBA issues an API key, client ID, client code, database name, and a username and password. See Credentials and environments.
2. Make your first call. The Quick start logs in and lists five groups in about five minutes, in C#, Python, or TypeScript.
3. Follow a playbook. Playbooks walk through whole workflows, such as onboarding an employer group or entering and adjudicating claims.

VBAPI gives your systems programmatic read and write access to your organization's VBASoftware data. Every call goes to one production host, https://vbapi.vbasoftware.com/vbasoftware, and names the database it works in with the vbasoftware-database header.

The API has two kinds of endpoints:

• Data-access endpoints read and write one kind of record. Most record types have list, get, create, update, delete, and batch operations, for example GET /counties, POST /counties, PUT /counties/{countyCode}, DELETE /counties/{countyCode}, and PUT /counties-batch.
• Advanced endpoints run VBASoftware business logic, such as adjudicating a claim queue with POST /claim-queues/{claimQueueKey}/adjudicate or disenrolling a group with POST /groups/{groupID}/disenroll. In the API reference, most of them are in the Advanced APIs group, under tags that start with Adv..

Creates, gets, lists, and updates return 200, deletes return 204, batch updates return 207, and advanced operations that queue work return 202. Requests and responses explains methods, status codes, and the response envelope.