API Documentation
Use the Dreamteam CRM API to work with records, associations, users, and pipelines. Plug your product into the daily workflows of Dreamteam sales teams.
Resources
Schema
Discover objects, properties, and association types available in the workspace.
Records
Create, list, retrieve, and update records across any object type.
Find Records
Filter records by any property, or batch-fetch a set of records by their IDs.
Users
List and retrieve the users that own records in the workspace.
Pipelines
List pipelines and get pipelines with their full stage layout.
Recipes
Task-oriented walkthroughs that chain the endpoints into a ready-made workflow.
Guides
Authentication
Learn how to authenticate your API requests with a bearer token.
Read morePagination & Sorting
Understand how to work with paginated list responses.
Read moreErrors
Read about the different HTTP error codes returned by the API.
Read moreConcepts
The vocabulary the rest of this doc uses.
| Record | One row in Dreamteam - a contact, company, deal, note, meeting, or task. Each has a stable numeric id. |
| Object type | The kind of record. One of contact, company, deal, note, meeting, task. |
| Property | A field on a record - like first_name on a contact, amount on a deal. Full list per object type: Describe Object. |
| Association | A link between two records - e.g. a contact belongs to a company. Full list: Association Definitions. |
| Pipeline | The stages a deal moves through, from open to closed won/lost. Read via Pipelines. |