Copy page

Team API

Use Cases & Best Practices

This page demonstrates practical workflows and production best practices for using the Team API effectively.

Common Use Cases

Here are brief examples of common workflows using the Team API.

Domain Management Workflow

Add a domain, verify DNS records, and attach it to a project:

Project and Route Setup

Create a project, add a route, and configure a webhook:

Message Monitoring

List messages with filters and retrieve detailed event history:

Suppression Management

Add email addresses to the suppression list and remove them when needed:

Best Practices

Security Recommendations

• Store tokens securely: Use environment variables or secrets managers (AWS Secrets Manager, HashiCorp Vault, etc.)
• Grant minimal abilities: Only assign the abilities each token needs to perform its function
• Rotate tokens regularly: Regenerate tokens periodically, especially for long-running integrations
• Monitor token usage: Check the "Last used" timestamp in the dashboard to identify inactive or compromised tokens
• Delete unused tokens: Remove tokens that are no longer needed

Operational Recommendations

• Implement error handling: Always handle HTTP errors gracefully with exponential backoff for retries
• Respect rate limits: Track X-RateLimit-Remaining headers and implement request queuing if needed
• Handle pagination: Use cursor-based pagination for large result sets
• Log request metadata: Store request IDs and timestamps for debugging
• Use descriptive names: Name tokens and resources clearly to aid in debugging and auditing

API Reference

Explore the complete API documentation for detailed endpoint information:

Next Steps

• API Tokens - Create and manage tokens with the right abilities
• API Reference - Explore all available endpoints
• Webhooks - Receive real-time delivery events
• Domain Verification - Set up and verify sending domains