/crm
logo
Documentation
API Reference
logo
Documentation
API Reference
No results found.
Introduction
Getting started with the Teamwork CRM API
Third Party App Login Flow
Formats and HTTP Methods
Webhooks
General Structure and Conventions
Entity types
Request structure
Response structure
Resource objects / entity models
Fetching a single resource
Fetching a list of resources
Sorting
Pagination
Filtering
Including related entities
Creating a resource
Updating a resource
Deleting a resource
Errors
Miscellaneous
Versioning
Rate limiting
Leads, opportunities, and deals
Dealing with custom fields
Uploading files
How can I show you what I made with the API?
Powered by Stoplight

Fetching a single resource

To fetch an individual entity, the request would look like GET {{entity-type}}/{{id}}.json. For example, GET deals/54.json; deals is the entity type, 54 is the ID of the deal.

See Response structure for an example response.

  • Pagination.
  • Including related entities.

Feedback

If you have any feedback or suggestions, feel free to contact us at api@teamwork.com.