API
Use the Vimub REST API and API keys to connect your own systems to Vimub.
The Vimub API lets developers read and write your Vimub data from other systems. API access is part of the Agency plan.
Full reference: app.vimub.com/docs/api. The machine-readable OpenAPI spec is at app.vimub.com/api/v1/openapi. You can import it into tools such as Postman.
Create an API key
You need to be the account owner or an admin.
Open the API keys page
Open the API keys & webhooks page at app.vimub.com/settings/api-keys. Under API keys, click Create key.
Name it and pick scopes
Give it a Name that says what it is for, for example "Website booking form". Tick only the Scopes it needs. Click Create.
Copy the key now
This is the only time Vimub shows it. If you lose it, create a new key.
Warning
Keep your key secret. Do not put it in website code that visitors can see.
Scopes
| Scope | Allows |
|---|---|
customers.read / customers.write | Read or create and update customers |
reviews.read / reviews.write | Read or update reviews |
bookings.read / bookings.write | Read or create bookings |
invoices.read / invoices.write | Read or create invoices |
campaigns.read / campaigns.write | Read or create campaigns |
webhooks.manage | Add and change webhook subscriptions |
Make a request
Send your key in the Authorization header to the /api/v1 endpoints:
curl https://app.vimub.com/api/v1/customers \
-H "Authorization: Bearer YOUR_API_KEY"Available resources include customers, reviews, bookings, invoices, campaigns, automations and webhooks.
Each key has a rate limit (120 requests a minute by default). If you go over it, wait a moment and try again.
Check key usage
The API keys table shows each key's Prefix, Scopes, number of Requests, a 14-day activity chart and when it was Last used.
Revoking a key stops it at once
Anything that uses a revoked key stops working straight away. Create the replacement key and update your systems first, unless the key may have leaked.
Click Revoke to switch off a key straight away, for example if it may have leaked.
Verify webhook deliveries
Webhook deliveries are signed with HMAC-SHA256. The signature is in the X-Vimub-Signature header. Use the signing secret shown when you created the endpoint to check each delivery before you trust it. See Integrations for the list of events.
Still need help?
Our team answers around the clock, every day.
© 2026 Quantum AI WebApps Digital LLC · vimub.com