API access - getting your key and what you can do with it

Teamopipe has a REST API that lets you read and write data programmatically — create deals from external sources, sync contacts with other tools, export data for reporting, or build custom automations. This covers getting your API key and what the API can do.

Getting your API key

1. Open the Teamopipe panel in Gmail.
2. Go to Settings → Workspace Settings.
3. Click API keys.
4. Click Generate key.
5. Copy the key and store it somewhere safe — it's shown once.

Note: API key management is admin-only. If you don't see the option in Workspace Settings, you're likely a member rather than an admin — ask your workspace admin.

Using your API key

Pass the key in the Authorization header of every request: Authorization: Bearer YOUR_API_KEY. The base URL is api.teamopipe.com/api/v2. Full interactive documentation — including request/response schemas and in-browser testing — is at api.teamopipe.com/api/v2/docs.

What the API covers

• Deals — create, read, update, delete; bulk creation, stage moves, custom field updates, activity logs, CSV export. Useful for syncing leads from a web form or pushing closed-deal data to a reporting tool.
• Contacts — full CRUD, bulk create, and upsert by email address — handy for keeping Teamopipe in sync with an external list. CSV export and activity entries supported.
• Organizations — full CRUD with bulk operations and CSV export. Useful for syncing company data from a CRM, ERP, or database.
• Pipelines & stages — read pipelines and stages; create, reorder, and rename stages programmatically.
• Custom fields — create and manage fields (called dynamic fields in the API), read definitions and options, and get or set values on deals, contacts, or organizations.
• Tasks — full CRUD with bulk operations and CSV export. Create follow-up tasks automatically from external triggers.
• Teams & members — read team details and member lists, manage invites.

Common use cases

• Web form → deal: create a deal automatically when someone fills in your website contact form
• Sync contacts with an external mailing list or database using upsert-by-email
• Pull deal and pipeline data into a Google Sheet or BI tool for reporting
• Create follow-up tasks from external triggers — a signed contract, a received payment

Revoking an API key

Settings → Workspace Settings → API keys → delete the key. Integrations using it lose access immediately; you can create a new key at any time.

If you have questions about the API, use the chat in the bottom-right corner or the contact form at teamopipe.com/en/contact — we typically respond within 4 hours on business days.