Teamleader icon

Teamleader

Consume Teamleader API

Actions67

Deals → List

AI-generated

Overview

This node interacts with the Teamleader API to list deals. It allows users to retrieve a list of deals with optional filtering by search term and customer (company or contact). Users can also specify a limit on the number of results returned. This is useful for scenarios where you want to fetch and process deal data from Teamleader, such as generating reports, syncing deals with other systems, or monitoring deal pipelines.

Use Case Examples

  1. Fetch a list of deals filtered by a specific search term to find relevant deals quickly.
  2. Retrieve deals associated with a particular customer (company or contact) to analyze customer-specific sales data.
  3. Limit the number of deals returned to manage data volume and improve performance in workflows.

Properties

Name Meaning
Filter by Term Filter deals by a search term (sent as filter.term). This helps narrow down the list to deals matching the term.
Customer Filter deals by customer type and ID (company or contact). Sent as filter.customer.{type,id} to retrieve deals related to a specific customer.
Limit The number of deal results to return. Controls the maximum number of deals fetched from the API.

Output

JSON

  • id - The unique identifier of the deal.
  • title - The title or name of the deal.
  • summary - Additional information or summary about the deal.
  • lead
    • customer
      * type - The type of the lead customer (company or contact).
      * id - The ID of the lead customer.
  • contact_person_id - Optional contact person ID associated with the deal.
  • source_id - Source ID of the deal.
  • department_id - Department ID associated with the deal.
  • phase_id - The phase ID indicating the current stage of the deal.
  • estimated_probability - Estimated probability of closing the deal.
  • estimated_closing_date - Estimated closing date of the deal in YYYY-MM-DD format.
  • estimated_value
    • amount - Estimated monetary value amount of the deal.
    • currency - Currency code for the estimated value.
  • currency
    • code - Currency code of the deal.
    • exchange_rate - Exchange rate for the currency.
  • custom_fields - Custom fields associated with the deal, if any.

Dependencies

  • Teamleader API OAuth2 credentials

Troubleshooting

  • If no data is returned but the request is successful, check if the filters applied are too restrictive or if there are no deals matching the criteria.
  • If the node throws a 'No data got returned' error, verify the API response and ensure the API credentials are valid and have the necessary permissions.
  • For authentication issues, ensure the OAuth2 credentials for Teamleader API are correctly configured and tested.

Links

Discussion