Skip to content

Latest commit

 

History

History
713 lines (539 loc) · 24.3 KB

SearchApi.md

File metadata and controls

713 lines (539 loc) · 24.3 KB

HubSpot.NET.Api.SearchApi

All URIs are relative to https://api.hubapi.com

Method HTTP request Description
GetMarketingV3MarketingEventsEventsSearch GET /marketing/v3/marketing-events/events/search Search for marketing events
PostCrmV3ObjectsCompaniesSearchDoSearch POST /crm/v3/objects/companies/search
PostCrmV3ObjectsContactsSearchDoSearch POST /crm/v3/objects/contacts/search
PostCrmV3ObjectsDealsSearchDoSearch POST /crm/v3/objects/deals/search
PostCrmV3ObjectsFeedbackSubmissionsSearchDoSearch POST /crm/v3/objects/feedback_submissions/search
PostCrmV3ObjectsLineItemsSearchDoSearch POST /crm/v3/objects/line_items/search
PostCrmV3ObjectsObjectTypeSearchDoSearch POST /crm/v3/objects/{objectType}/search
PostCrmV3ObjectsProductsSearchDoSearch POST /crm/v3/objects/products/search
PostCrmV3ObjectsQuotesSearchDoSearch POST /crm/v3/objects/quotes/search
PostCrmV3ObjectsTicketsSearchDoSearch POST /crm/v3/objects/tickets/search

GetMarketingV3MarketingEventsEventsSearch

CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging GetMarketingV3MarketingEventsEventsSearch (string q)

Search for marketing events

Search for marketing events that have an event id that starts with the query string

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetMarketingV3MarketingEventsEventsSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var q = "q_example";  // string | The partial event id to search for

            try
            {
                // Search for marketing events
                CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging result = apiInstance.GetMarketingV3MarketingEventsEventsSearch(q);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.GetMarketingV3MarketingEventsEventsSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
q string The partial event id to search for

Return type

CollectionResponseMarketingEventExternalUniqueIdentifierNoPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsCompaniesSearchDoSearch

CollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsCompaniesSearchDoSearch (PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsCompaniesSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                CollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsCompaniesSearchDoSearch(publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsCompaniesSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
publicObjectSearchRequest PublicObjectSearchRequest

Return type

CollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsContactsSearchDoSearch

ContactsCollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsContactsSearchDoSearch (PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsContactsSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                ContactsCollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsContactsSearchDoSearch(publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsContactsSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
publicObjectSearchRequest PublicObjectSearchRequest

Return type

ContactsCollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsDealsSearchDoSearch

DealsCollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsDealsSearchDoSearch (PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsDealsSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                DealsCollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsDealsSearchDoSearch(publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsDealsSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
publicObjectSearchRequest PublicObjectSearchRequest

Return type

DealsCollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsFeedbackSubmissionsSearchDoSearch

FeedbackSubmissionsCollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsFeedbackSubmissionsSearchDoSearch (PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsFeedbackSubmissionsSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                FeedbackSubmissionsCollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsFeedbackSubmissionsSearchDoSearch(publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsFeedbackSubmissionsSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
publicObjectSearchRequest PublicObjectSearchRequest

Return type

FeedbackSubmissionsCollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsLineItemsSearchDoSearch

LineItemsCollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsLineItemsSearchDoSearch (PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsLineItemsSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                LineItemsCollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsLineItemsSearchDoSearch(publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsLineItemsSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
publicObjectSearchRequest PublicObjectSearchRequest

Return type

LineItemsCollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsObjectTypeSearchDoSearch

ObjectsCollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsObjectTypeSearchDoSearch (string objectType, PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsObjectTypeSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var objectType = "objectType_example";  // string | 
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                ObjectsCollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsObjectTypeSearchDoSearch(objectType, publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsObjectTypeSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
objectType string
publicObjectSearchRequest PublicObjectSearchRequest

Return type

ObjectsCollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsProductsSearchDoSearch

CollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsProductsSearchDoSearch (PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsProductsSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                CollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsProductsSearchDoSearch(publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsProductsSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
publicObjectSearchRequest PublicObjectSearchRequest

Return type

CollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsQuotesSearchDoSearch

QuotesCollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsQuotesSearchDoSearch (PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsQuotesSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                QuotesCollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsQuotesSearchDoSearch(publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsQuotesSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
publicObjectSearchRequest PublicObjectSearchRequest

Return type

QuotesCollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostCrmV3ObjectsTicketsSearchDoSearch

TicketsCollectionResponseWithTotalSimplePublicObjectForwardPaging PostCrmV3ObjectsTicketsSearchDoSearch (PublicObjectSearchRequest publicObjectSearchRequest)

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsTicketsSearchDoSearchExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new SearchApi(config);
            var publicObjectSearchRequest = new PublicObjectSearchRequest(); // PublicObjectSearchRequest | 

            try
            {
                TicketsCollectionResponseWithTotalSimplePublicObjectForwardPaging result = apiInstance.PostCrmV3ObjectsTicketsSearchDoSearch(publicObjectSearchRequest);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling SearchApi.PostCrmV3ObjectsTicketsSearchDoSearch: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
publicObjectSearchRequest PublicObjectSearchRequest

Return type

TicketsCollectionResponseWithTotalSimplePublicObjectForwardPaging

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, /

HTTP response details

Status code Description Response headers
200 successful operation -
0 An error occurred. -

[Back to top] [Back to API list] [Back to Model list] [Back to README]