TukiMate icon

TukiMate

Interact with TukiMate API (conversations, contacts, teams, projects, clients, sources)

Actions48

Opportunity → List

AI-generated

Summary

List opportunities applying optional filters like status, type, owner, team, and conversation ID, with support for pagination, sorting, and including related data.

Inputs

  • Status — Filter opportunities by their status: All (default), Pending, Approved, Rejected, or Converted.
  • Conversation ID — Filter opportunities related to a specific conversation ID.
  • Type Filter — Filter opportunities by type: All (default), New Sale, Upselling, Renewal/Retention, or Cross Sell.
  • Owner ID — Filter opportunities by the owner's ID.
  • Team ID — Filter opportunities by team ID.
  • Include Relations — Choose to include related entities in the response data.
  • Limit — Maximum number of opportunities to return (default 50).
  • Offset — Number of opportunities to skip before starting to return results (default 0).
  • Sort By — Field to order opportunities by, defaulting to Created At. Options: Created At, Updated At, Title, Status, Expected Close Date.
  • Sort Order — Sort direction, Descending (default) or Ascending.
  • Simplified Output — Return only essential fields excluding internal metadata like tenant_id and timestamps.

Output shape

a list of opportunity records

The response is an array of opportunity objects filtered, paginated, and sorted per the input parameters. When 'Include Relations' is true, related entities are included in the response. If 'Simplified Output' is enabled, only essential fields are returned, excluding internal or metadata fields.

Examples

Example 1: Fetch up to 20 approved opportunities owned by a specific owner, sorted by expected close date ascending, and include related data.

Set Status to Approved, Owner ID to the given owner identifier, Limit to 20, Sort By to Expected Close Date, Sort Order to Ascending, and enable Include Relations.

Links

Discussion