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

May 20, 2026

Teamopipe has a REST API for reading and writing your data — create deals from external sources, sync contacts with other tools, or pull data for reporting. API access is included on every plan.

Create an API key

  1. Go to Settings → Integrations.
  2. Under API keys, click Create new key.
  3. Give it a name that identifies the integration, and review the scope and warning Teamopipe shows.
  4. Copy the key and store it in a secret store or password manager.

Only workspace admins can manage API keys. Never paste a key into email, chat, tickets, source code or screenshots, and use one key per integration.

Use the key

Send the key in the Authorization header: Authorization: Bearer YOUR_API_KEY. The base URL is api.teamopipe.com/api/v2. Full interactive documentation is at api.teamopipe.com/api/v2/docs.

Test it safely

  1. Make a read call first, such as listing pipelines.
  2. If it returns your data, the key works.
  3. Only then try a write, with a clearly fake record, and delete it afterwards.

What the API covers

  • Deals — create, read, update, delete; bulk creation, stage moves, custom field updates and CSV export.
  • Contacts — full CRUD, bulk create, and upsert by email address.
  • Organizations — full CRUD with bulk operations and CSV export.
  • Pipelines and stages — read pipelines; create, reorder and rename stages.
  • Custom fields — create and manage fields (called dynamic fields in the API) and set their values.
  • Tasks — full CRUD with bulk operations and CSV export.
  • Teams and members — read team details and members, manage invites.

Common problems

  • Requests rejected: the key was copied incompletely, or was deleted.
  • Nothing is created: check the required fields and ids in the interactive documentation.

Revoke a key

Go to Settings → Integrations → API keys and delete the key. Anything using it loses access immediately.

Prefer no code? Use Zapier. Want to work with your CRM from Claude or ChatGPT? See Teamopipe MCP — it doesn't need an API key; it uses sign-in and workspace approval instead.

Related articles: available API endpoints, keeping your API keys secure.

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

Related articles