API Evangelist conversational phrasing for Hubspot Search API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hubspot Search API
  version: 1.0.0
extends: openapi/hubspot-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 36
- target: $.paths['/crm/objects/2026-03/{objectType}/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search records of any CRM object type
      effect: read
      questions:
      - Is there one search endpoint that works for whatever CRM object type I name, such as appointments?
      - Can I run a filtered CRM search against a custom object by passing its object type?
      instructions:
      - text: Search {objectType} records matching {query}.
        slots:
          objectType: path.objectType
          query: requestBody.query
      - text: Find up to {limit} {objectType} records and return only the {properties} properties.
        slots:
          limit: requestBody.limit
          objectType: path.objectType
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/calls/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search logged calls
      effect: read
      questions:
      - How do I find logged calls in the CRM that match certain property values?
      - Can I sort call records by a property when I search them?
      instructions:
      - text: Search my logged calls for {query}.
        slots:
          query: requestBody.query
      - text: Find up to {limit} call engagements, sorted by {sorts}.
        slots:
          limit: requestBody.limit
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/carts/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search shopping carts
      effect: read
      questions:
      - Can I look up carts in the CRM by filtering on their properties?
      - What is the most carts a single cart search returns per page?
      instructions:
      - text: Search carts for {query}.
        slots:
          query: requestBody.query
      - text: Pull {limit} carts and include only the {properties} fields.
        slots:
          limit: requestBody.limit
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/commerce_payments/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search commerce payment records
      effect: read
      questions:
      - Is there a way to query payment records collected through HubSpot commerce with filter groups?
      - Can I find commerce payments whose properties match several conditions at once?
      instructions:
      - text: Search commerce payments for {query}.
        slots:
          query: requestBody.query
      - text: Find commerce payments matching {filterGroups}.
        slots:
          filterGroups: requestBody.filterGroups
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/communications/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search logged communication messages
      effect: read
      questions:
      - Can I search the logged communications messages attached to CRM records?
      - Where do I query logged message records using property filters?
      instructions:
      - text: Search logged communication messages for {query}.
        slots:
          query: requestBody.query
      - text: List {limit} communications records sorted by {sorts}.
        slots:
          limit: requestBody.limit
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/companies/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search companies
      effect: read
      questions:
      - How do I find companies in my CRM by searching for a name?
      - Can I combine up to six filter groups when searching companies?
      instructions:
      - text: Search companies for {query}.
        slots:
          query: requestBody.query
      - text: Find companies matching {filterGroups} and return {properties}.
        slots:
          filterGroups: requestBody.filterGroups
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/contacts/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search contacts
      effect: read
      questions:
      - What's the way to find contacts whose properties match a filter, like a lifecycle stage?
      - Can a contact search return more than 200 people in one page?
      instructions:
      - text: Search contacts for {query}.
        slots:
          query: requestBody.query
      - text: Find contacts matching {filterGroups}, sorted by {sorts}.
        slots:
          filterGroups: requestBody.filterGroups
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/0-410/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search courses
      effect: read
      questions:
      - Can I search course records in the CRM by their properties?
      - Which endpoint looks up courses matching a text query?
      instructions:
      - text: Search courses for {query}.
        slots:
          query: requestBody.query
      - text: Return {limit} course records with the {properties} properties.
        slots:
          limit: requestBody.limit
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/0-3/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search deals
      effect: read
      questions:
      - How do I find deals in my pipeline that match certain criteria?
      - Can I sort deals by a property such as amount when I search them?
      instructions:
      - text: Search deals for {query}.
        slots:
          query: requestBody.query
      - text: Find deals matching {filterGroups} sorted by {sorts}.
        slots:
          filterGroups: requestBody.filterGroups
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/discounts/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search discounts
      effect: read
      questions:
      - Can I query discount records in the CRM using filters?
      - Is there a text search over the discounts in my account?
      instructions:
      - text: Search discounts for {query}.
        slots:
          query: requestBody.query
      - text: Get the next page of discount results after {after}.
        slots:
          after: requestBody.after
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/emails/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search logged emails
      effect: read
      questions:
      - Can I search the email engagements logged on CRM records?
      - What filters can I use to narrow a search of logged emails?
      instructions:
      - text: Search logged emails for {query}.
        slots:
          query: requestBody.query
      - text: Find logged email engagements matching {filterGroups}.
        slots:
          filterGroups: requestBody.filterGroups
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/feedback_submissions/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search feedback submissions
      effect: read
      questions:
      - Can I pull feedback submissions that match specific property values?
      - How do I search customer feedback submissions stored in the CRM?
      instructions:
      - text: Search feedback submissions for {query}.
        slots:
          query: requestBody.query
      - text: Return {limit} feedback submissions sorted by {sorts}.
        slots:
          limit: requestBody.limit
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/fees/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search fees
      effect: read
      questions:
      - Can I search fee records in the CRM with filters and sorting?
      - Is there a way to page through fee search results with a cursor?
      instructions:
      - text: Search fees for {query}.
        slots:
          query: requestBody.query
      - text: Fetch fees matching {filterGroups} with the {properties} fields.
        slots:
          filterGroups: requestBody.filterGroups
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/goal_targets/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search goal targets
      effect: read
      questions:
      - Can I look up goal targets by filtering on their properties?
      - Which call searches the goal targets set up in my account?
      instructions:
      - text: Search goal targets for {query}.
        slots:
          query: requestBody.query
      - text: List {limit} goal targets sorted by {sorts}.
        slots:
          limit: requestBody.limit
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/invoices/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search invoices
      effect: read
      questions:
      - How do I find invoices that meet several filter conditions?
      - Can I sort invoice search results and page through them?
      instructions:
      - text: Search invoices for {query}.
        slots:
          query: requestBody.query
      - text: Find invoices matching {filterGroups} and return {properties}.
        slots:
          filterGroups: requestBody.filterGroups
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/leads/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search leads
      effect: read
      questions:
      - Can I search leads and get up to 200 of them per page?
      - Which endpoint filters lead records by their properties?
      instructions:
      - text: Search leads for {query}.
        slots:
          query: requestBody.query
      - text: Find leads matching {filterGroups} sorted by {sorts}.
        slots:
          filterGroups: requestBody.filterGroups
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/line_items/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search line items
      effect: read
      questions:
      - Can I find line items that match specific property conditions?
      - What's the page size cap when searching line items?
      instructions:
      - text: Search line items for {query}.
        slots:
          query: requestBody.query
      - text: Return {limit} line items with the {properties} properties.
        slots:
          limit: requestBody.limit
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/0-420/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search listings
      effect: read
      questions:
      - Can I search listing records by their properties?
      - Which endpoint runs a text query across my listings?
      instructions:
      - text: Search listings for {query}.
        slots:
          query: requestBody.query
      - text: Find listings matching {filterGroups}.
        slots:
          filterGroups: requestBody.filterGroups
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/lists/2026-03/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search CRM lists by name
      effect: read
      questions:
      - How do I find a CRM list by its name?
      - Can I page through every list in my account by leaving the search query empty?
      - Can I limit a list search to certain processing types, like manual or dynamic lists?
      instructions:
      - text: Find lists named {query}.
        slots:
          query: requestBody.query
      - text: Page through {count} lists starting at offset {offset}.
        slots:
          count: requestBody.count
          offset: requestBody.offset
      - text: Search lists with processing type {processingTypes}.
        slots:
          processingTypes: requestBody.processingTypes
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/meetings/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search meetings
      effect: read
      questions:
      - Can I search the meetings logged in the CRM by property?
      - Is it possible to find meetings by searching through their associations?
      instructions:
      - text: Search meetings for {query}.
        slots:
          query: requestBody.query
      - text: List {limit} meetings sorted by {sorts}.
        slots:
          limit: requestBody.limit
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/notes/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search notes
      effect: read
      questions:
      - Can I search the notes on CRM records for a keyword?
      - Which endpoint lets me filter notes by property values?
      instructions:
      - text: Search notes for {query}.
        slots:
          query: requestBody.query
      - text: Find notes matching {filterGroups} and return {properties}.
        slots:
          filterGroups: requestBody.filterGroups
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/orders/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search orders
      effect: read
      questions:
      - Can I search commerce orders in the CRM with filters?
      - How do I look up orders that match a text query?
      instructions:
      - text: Search orders for {query}.
        slots:
          query: requestBody.query
      - text: Return {limit} orders sorted by {sorts}.
        slots:
          limit: requestBody.limit
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/partner_clients/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search partner clients
      effect: read
      questions:
      - Can I search my partner clients using property filters?
      - Which call returns partner client records that match a query?
      instructions:
      - text: Search partner clients for {query}.
        slots:
          query: requestBody.query
      - text: Find partner clients matching {filterGroups}.
        slots:
          filterGroups: requestBody.filterGroups
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/partner_services/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search partner services
      effect: read
      questions:
      - Can I search the partner services records in my account?
      - What's the way to filter partner services and sort the results?
      instructions:
      - text: Search partner services for {query}.
        slots:
          query: requestBody.query
      - text: List {limit} partner services with the {properties} fields.
        slots:
          limit: requestBody.limit
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/postal_mail/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search postal mail records
      effect: read
      questions:
      - Can I search the postal mail engagements logged in the CRM?
      - Is there a filterable search for postal mail objects?
      instructions:
      - text: Search postal mail records for {query}.
        slots:
          query: requestBody.query
      - text: Find postal mail logged with {filterGroups}.
        slots:
          filterGroups: requestBody.filterGroups
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/products/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search products
      effect: read
      questions:
      - How do I search my product library by property values?
      - Can I apply multiple filter groups when searching products?
      instructions:
      - text: Search products for {query}.
        slots:
          query: requestBody.query
      - text: Find products matching {filterGroups} sorted by {sorts}.
        slots:
          filterGroups: requestBody.filterGroups
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/projects/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search projects
      effect: read
      questions:
      - Can I search project records in the CRM?
      - Which endpoint filters projects by property and association?
      instructions:
      - text: Search projects for {query}.
        slots:
          query: requestBody.query
      - text: Return {limit} projects with the {properties} properties.
        slots:
          limit: requestBody.limit
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/quotes/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search quotes
      effect: read
      questions:
      - Can I search sales quotes by filter criteria?
      - How do I pull the quotes that match a text query?
      instructions:
      - text: Search quotes for {query}.
        slots:
          query: requestBody.query
      - text: Find quotes matching {filterGroups} sorted by {sorts}.
        slots:
          filterGroups: requestBody.filterGroups
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/0-162/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search service records
      effect: read
      questions:
      - Can I search service records in the CRM, not partner services?
      - Which endpoint runs a filtered search over my services object?
      instructions:
      - text: Search service records for {query}.
        slots:
          query: requestBody.query
      - text: Return {limit} service records sorted by {sorts}.
        slots:
          limit: requestBody.limit
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/tasks/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search tasks
      effect: read
      questions:
      - How do I find CRM tasks matching certain conditions?
      - Can I sort task search results by one of the task's properties?
      instructions:
      - text: Search tasks for {query}.
        slots:
          query: requestBody.query
      - text: Find tasks matching {filterGroups} and return {properties}.
        slots:
          filterGroups: requestBody.filterGroups
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/taxes/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search tax records
      effect: read
      questions:
      - Can I search the tax objects in my CRM?
      - What properties can I return when searching tax records?
      instructions:
      - text: Search tax records for {query}.
        slots:
          query: requestBody.query
      - text: List {limit} tax records sorted by {sorts}.
        slots:
          limit: requestBody.limit
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/tickets/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search support tickets
      effect: read
      questions:
      - How do I find support tickets that match a filter, like a pipeline stage?
      - Can I search tickets by text and sort the results?
      instructions:
      - text: Search tickets for {query}.
        slots:
          query: requestBody.query
      - text: Find tickets matching {filterGroups} sorted by {sorts}.
        slots:
          filterGroups: requestBody.filterGroups
          sorts: requestBody.sorts
      method: generated
      generated: '2026-09-24'
- target: $.paths['/crm/objects/2026-03/users/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search CRM user records
      effect: read
      questions:
      - Can I search the user records stored as CRM objects?
      - Which endpoint filters CRM users by their properties?
      instructions:
      - text: Search CRM users for {query}.
        slots:
          query: requestBody.query
      - text: Return {limit} user records with the {properties} properties.
        slots:
          limit: requestBody.limit
          properties: requestBody.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/public/api/versioning/test/2026-09-beta/widgets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a test widget
      effect: write
      questions:
      - Can I create a widget through the public API versioning test service?
      - Is there a beta endpoint for creating test widgets?
      instructions:
      - text: Create a new test widget in my account.
      - text: Create a widget with the versioning test service beta endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/public/api/versioning/test/2026-09-beta/widgets/{widgetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a test widget
      effect: read
      questions:
      - How do I fetch a single widget by its ID?
      - Can I look up the details of a test widget I created?
      instructions:
      - text: Get widget {widgetId}.
        slots:
          widgetId: path.widgetId
      - text: Show the details of test widget {widgetId}.
        slots:
          widgetId: path.widgetId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/public/api/versioning/test/2026-09-beta/widgets/{widgetId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a test widget
      effect: destructive
      questions:
      - Can I remove a test widget I no longer need?
      - What does deleting a widget return when it succeeds?
      instructions:
      - text: Delete widget {widgetId}.
        slots:
          widgetId: path.widgetId
      - text: Remove test widget {widgetId} from my account.
        slots:
          widgetId: path.widgetId
      method: generated
      generated: '2026-09-24'