API Keys allow you to connect external systems and tools to your ZippyAssist account programmatically. Use them to pull request data, sync equipment, build integrations, or automate workflows using the ZippyAssist public API.
Where to Find API Keys
Go to Settings → API Keys in your dashboard. From here you can view, create, edit, and delete keys for your organization.
Access to API key management requires the appropriate user permissions. If you don't see the API Keys section, contact your account administrator.
Creating an API Key
Go to Settings → API Keys.
Click Add Key.
Enter a Name for the key — use something descriptive so you can identify it later (e.g., "Warehouse Integration" or "Analytics Export").
Leave Enabled toggled on.
Click Save.
After saving, a dialog will display your new API Key and API Secret. Copy and store both values immediately in a secure location such as a password manager — the secret will not be shown again.
Credential | Length | Purpose |
API Key | 24 characters | Identifies your organization in API requests |
API Secret | 64 characters | Authenticates the request (keep this private) |
Using Your API Key
All requests to the ZippyAssist public API must include both credentials as request headers:
Header | Value |
| Your API Key |
| Your API Secret |
Base URL: https://api.zippyassist.com/public/v1/
Full API documentation: api.zippyassist.com/docs
Available Resources
The following resources are accessible through the public API:
Resource | Supported Actions |
Help Requests | List, View, Update |
Refund Requests | List, View, Update |
Feedback | List, View |
Voice Messages | List, View |
Customers | List, View |
Users | List, View |
Escalations | List, View |
Equipment | List, View, Create, Update, Delete |
Equipment Types | List, View, Create, Update, Delete |
Request Types | List, View, Create, Update, Delete |
Machine Types | List, View, Create, Update, Delete |
Refund Methods | List, View |
Payment Methods | List, View |
You can also import equipment in bulk via POST /tag_import and check the status of an import via GET /tag_import/{id}/status.
Disabling a Key
If you need to temporarily revoke access without permanently deleting a key:
Go to Settings → API Keys.
Click the actions menu for the key and select Edit.
Toggle Enabled to off.
Click Save.
Disabled keys will be rejected by the API until re-enabled.
Deleting a Key
Go to Settings → API Keys.
Click the actions menu for the key and select Delete.
Confirm the deletion.
Deleting a key is permanent. Any integrations using that key will immediately lose access. If in doubt, disable the key first.
Security Tips
Store your API secret in a password manager or secrets vault — never in plain text or source code.
Create separate keys for separate integrations so you can revoke one without affecting others.
Disable or delete keys that are no longer in use.
If you have any questions, contact us at [email protected]