Skip to main content

ā€‹
Prerequisites

Before you begin using the Quo API, ensure you have:

An active Quo subscription

Need an account? Follow our account creation guide.

Admin access

Owner or admin privileges in your Quo workspace.
US Messaging Registration Required: To send text messages to US numbers via the API, you must complete US Carrier Registration. Learn more here.

ā€‹
API key generation

The Quo API uses API keys for secure authentication. Follow these steps to get started:
1

Log in to Quo

Access your Quo account.
2

Access API Settings

Navigate to the ā€œAPIā€ tab under workspace settings. Remember, you need workspace owner or admin privileges to access this tab.
3

Generate your key

Click ā€œGenerate API keyā€ and provide a descriptive label. Each key provides full API access.
Label your keys based on their intended use (e.g., ā€œProduction Environmentā€ or ā€œTesting Integrationā€)
4

Implement authentication

Include your API key in the Authorization header of each request: Authorization: YOUR_API_KEY
The Quo API does not use a Bearer token for authentication.

ā€‹
Security guidelines

Your API key carries the same privileges as your Quo account. Treat it with the same level of security as your password.

ā€‹
Best practices

  • Keep your API keys confidential
  • Donā€™t share your API keys in publicly accessible areas such as GitHub or client-side code
  • Regularly rotate your API keys to enhance security
  • If a key is compromised, revoke it immediately and generate a new one

ā€‹
Revoking access

If a key is compromised or no longer needed:
  1. Navigate to the ā€œAPIā€ tab in Workspace Settings
  2. Locate the specific key
  3. Click the ellipsis (three dots) icon and select ā€˜deleteā€™ to immediately revoke access
  4. Generate a new key if needed
Deleting an API key only affects the integrations using that specific key. Other keys and integrations will continue to function normally.
āŒ˜I