What Teamopipe API endpoints are available
Teamopipe's API provides endpoints for reading and writing your data: deals, contacts, pipelines, tasks and more.
Before you start
- You need a workspace API key from Settings → Integrations → API keys. See API access: getting your key.
- Keep the key private — see keeping your API keys and integrations secure.
Deals endpoints
- GET /deals — retrieve all deals
- POST /deals — create a deal
- PUT /deals/{id} — update a deal
- DELETE /deals/{id} — delete a deal
Contacts endpoints
- GET /contacts — retrieve all contacts
- POST /contacts — create a contact
- PUT /contacts/{id} — update a contact
- DELETE /contacts/{id} — delete a contact
Pipelines endpoints
- GET /pipelines — retrieve all pipelines
- GET /pipelines/{id} — get a specific pipeline
Tasks endpoints
- GET /tasks — retrieve all tasks
- POST /tasks — create a task
- PUT /tasks/{id} — update a task
- DELETE /tasks/{id} — delete a task
A safe first test
- Start with a read call such as GET /pipelines. It changes nothing and confirms your key works.
- Note the id of the pipeline you want to use.
- Create a test contact with POST /contacts, then check it appears in Contacts in the app.
- Delete the test record when you're done.
Typical example flow
Create a contact with POST /contacts, create a deal in a pipeline with POST /deals, then create a follow-up task with POST /tasks. Afterwards check all three in the app.
Common problems
- The request is rejected: check the API key is the current one and has been copied in full.
- A record isn't created: check the pipeline id and the required fields for that record.
- Unexpected data: use GET calls to compare what was stored with what you sent.
Revoke access
If a key is exposed, remove it in Settings → Integrations → API keys and create a new one. See keeping your API keys and integrations secure.
Related articles: common API use cases, connect Teamopipe to Zapier.
If you run into issues, use the chat in the bottom-right corner or the contact form — we typically respond within 4 hours on business days.