Authentication

All requests to the SparrowDesk REST API must be authenticated using a bearer token. This guide explains how to obtain and use bearer tokens to authenticate your API requests.

Overview

The SparrowDesk REST API uses bearer token authentication. You must include a valid bearer token in the Authorization header of every API request.

Obtaining a Bearer Token

To authenticate with the API, you need to obtain a bearer token from your SparrowDesk account.

1. Login to your SparrowDesk account
2. Navigate to settings and click on the API keys page.

Once you have your bearer token, you'll use it to authenticate all API requests.

Using Bearer Tokens

Include your bearer token in the Authorization header of every API request using the following format:

Authorization: Bearer YOUR_TOKEN_HERE

Example: cURL

curl -X GET "https://api.sparrowdesk.com/v1/contacts" \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json"

Security Best Practices

1. Keep your token secure: Never commit bearer tokens to version control or share them publicly.

2. Use environment variables: Store your bearer token in environment variables rather than hardcoding it in your application.

3. Regenerate tokens: In case of a security breach, regenerate your bearer tokens to prevent unauthorized access.

4. Use HTTPS only: Always make API requests over HTTPS to ensure your token is transmitted securely.

Error Responses

If your bearer token is missing, invalid, or expired, the API will return a 401 Unauthorized error:

{
  "message": "Unauthorized"
}

Next Steps

• Check the rate limits to understand API usage limits
• Explore the API reference for detailed endpoint documentation