Authentication

Learn how to gain API access.

Prerequisites

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

• Need an account? Follow our account creation guide.
• 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. Access your Quo account.
2. Navigate to the "API" tab under workspace settings. Remember, you need workspace owner or admin privileges to access this tab.
3. 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. 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.