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 article covers how to get 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 (or Create a new API 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 may be a member rather than an admin on the workspace. Contact your workspace admin or email support@teamopipe.com.

Using your API key

Pass your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

The base URL for all API calls is api.teamopipe.com/api/v2. The full interactive documentation, including request/response schemas and the ability to test calls directly in the browser, is available at api.teamopipe.com/api/v2/docs.

What the API covers

The Teamopipe API covers all major data types in the product:

Deals

Create, read, update, and delete deals. Create deals in bulk, move them between stages, update custom fields, add activity logs, and export pipeline data to CSV. Useful for syncing leads from a web form, importing from another source, or pushing closed deal data to a reporting tool.

Contacts

Create, read, update, and delete contacts. Bulk-create or upsert contacts by email address (useful for keeping Teamopipe in sync with an external list). Export contacts to CSV. Add activity entries to a contact’s log.

Organizations

Create, read, update, and delete organizations. Bulk operations supported. Export to CSV. Useful for syncing company data from a CRM, ERP, or database.

Pipelines & stages

Read pipelines and their stages. Create new stages, reorder stages, update stage names. Useful when setting up a workspace programmatically.

Custom fields

Create and manage custom fields (called dynamic fields in the API). Read field definitions and choice options. Get and set custom field values on specific deals, contacts, or organizations.

Tasks

Create, read, update, and delete tasks. Bulk create or update. Export tasks to CSV. Useful for creating follow-up tasks automatically when a deal reaches a certain stage in an external workflow.

Teams & members

Read team details and member lists. Manage invites. Useful for provisioning new team members programmatically.

Common use cases

• Web form → deal: When someone fills in a contact form on your website, use the API to automatically create a deal in Teamopipe with the form data pre-filled
• Sync contacts: Keep your Teamopipe contact list in sync with an external mailing list, database, or CRM using upsert-by-email
• Export for reporting: Pull deal and pipeline data into a Google Sheet or BI tool for analysis
• Automated tasks: Create follow-up tasks on deals based on external triggers (e.g. a contract signed in DocuSign, or a payment received)

Revoking an API key

To revoke a key: Settings → Workspace Settings → API keys → delete the key. Any integrations using that key will immediately lose access. You can create a new key at any time.

No-code option: Zapier (coming Q2 2026)

If you want to connect Teamopipe to other tools without writing code, Zapier integration is coming in Q2 2026. Zapier will let you build automations using a visual interface — connect Teamopipe to tools like Google Sheets, Slack, Typeform, HubSpot, and thousands of others. See the Zapier integration article for what will be possible.

If you have questions about the API, email support@teamopipe.com — we typically respond within 4 hours on business days.