> ## Documentation Index > Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Search for deals using various filters and criteria to retrieve specific records. > Pesquise negócios usando critérios e filtros específicos. > **Supported products** > **Required Scopes** ## OpenAPI ````yaml specs/legacy/v3/crm-deals-v3.json POST /crm/v3/objects/0-3/search openapi: 3.0.1 info: title: Negócios description: >- CRM objects such as companies, contacts, deals, line items, products, tickets, and quotes are standard objects in HubSpot’s CRM. These core building blocks support custom properties, store critical information, and play a central role in the HubSpot application. ## Supported Object Types This API provides access to collections of CRM objects, which return a map of property names to values. Each object type has its own set of default properties, which can be found by exploring the [CRM Object Properties API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview). |Object Type |Properties returned by default | |--|--| | `companies` | `name`, `domain` | | `contacts` | `firstname`, `lastname`, `email` | | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` | | `products` | `name`, `description`, `price` | | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`, `hs_ticket_category`, `hs_ticket_priority`, `subject` | Find a list of all properties for an object type using the [CRM Object Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties) API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`. Change the properties returned in the response using the `properties` array in the request body. version: v3 x-hubspot-product-tier-requirements: marketing: FREE sales: FREE service: FREE cms: FREE commerce: FREE crmHub: FREE dataHub: FREE x-hubspot-api-use-case: >- Quando um representante de vendas começa a trabalhar com um possível cliente, crie um registro de negócio para acompanhar o processo de negociação. Quando o cliente fizer a compra, você pode atualizar o negócio para uma fase de negócio fechado. x-hubspot-related-documentation: - name: Deals Guide url: https://developers.hubspot.com/docs/guides/api/crm/objects/deals x-hubspot-introduction: >- Use a API de negócios para criar e gerenciar registros de CRM que representam transações com contatos e/ou empresas. Os negócios passam pelas fases do pipeline para refletir se a transação foi concluída, está ativa ou foi perdida. servers: - url: https://api.hubapi.com security: [] tags: - name: Basic - name: Batch - name: Search paths: /crm/v3/objects/0-3/search: post: tags: - Search summary: >- Pesquise negócios usando vários filtros e critérios para recuperar registros específicos. description: Pesquise negócios usando critérios e filtros específicos. operationId: post-/crm/v3/objects/0-3/search_doSearch parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/PublicObjectSearchRequest' required: true responses: '200': description: successful operation content: application/json: schema: $ref: >- #/components/schemas/CollectionResponseWithTotalSimplePublicObject default: $ref: '#/components/responses/Error' description: '' security: [] components: schemas: PublicObjectSearchRequest: required: - after - filterGroups - limit - properties - sorts type: object properties: after: type: string description: Um token de cursor de paginação para recuperar páginas subsequentes. filterGroups: type: array description: Até 6 grupos de filtros definindo critérios de consulta adicionais. items: $ref: '#/components/schemas/FilterGroup' limit: type: integer description: O máximo de resultados a serem retornados é de até 200 objetos. format: int32 properties: type: array description: Uma lista de nomes de propriedades a serem incluídos na resposta. items: type: string query: type: string description: A sequência de consulta de pesquisa, até 3000 caracteres. sorts: type: array description: >- Especifica a ordem de classificação com base nas propriedades do objeto. items: type: string description: Descreve uma solicitação de pesquisa CollectionResponseWithTotalSimplePublicObject: required: - results - total type: object properties: paging: $ref: '#/components/schemas/Paging' results: type: array description: >- Um array contendo os objetos públicos simples retornados na página atual da resposta. Esta propriedade é obrigatória. items: $ref: '#/components/schemas/SimplePublicObject' total: type: integer description: O número de resultados disponíveis format: int32 description: >- Representa uma lista de objetos simples retornados de uma solicitação de API, juntamente com o número total de objetos disponíveis. FilterGroup: required: - filters type: object properties: filters: type: array description: >- Uma lista de critérios de filtro individuais que são aplicados juntos como um grupo. Cada filtro especifica uma condição que os registros devem atender para serem incluídos nos resultados. items: $ref: '#/components/schemas/Filter' description: >- Representa um grupo de filtros usados para consultar dados no HubSpot. Este componente é usado para definir critérios de filtragem de registros em vários endpoints de API. Paging: type: object properties: next: $ref: '#/components/schemas/NextPage' prev: $ref: '#/components/schemas/PreviousPage' description: >- Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados. SimplePublicObject: required: - archived - createdAt - id - properties - updatedAt type: object properties: archived: type: boolean description: Se o objeto está arquivado ou não. archivedAt: type: string description: A data e hora em que o objeto foi arquivado, no formato ISO 8601. format: date-time createdAt: type: string description: A data e hora em que o objeto foi criado, no formato ISO 8601. format: date-time id: type: string description: O ID exclusivo do objeto. objectWriteTraceId: type: string description: >- Um identificador usado para rastrear a solicitação de criação ou atualização do objeto. properties: type: object additionalProperties: type: string description: Pares de chave-valor que representam as propriedades do objeto. propertiesWithHistory: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ValueWithTimestamp' description: >- Pares de chave-valor que representam as propriedades do objeto junto com seu histórico. updatedAt: type: string description: >- A data e hora em que o objeto foi atualizado pela última vez, no formato ISO 8601. format: date-time url: type: string description: O URL associado ao objeto. warnings: type: array items: $ref: '#/components/schemas/PublicObjectWarning' description: Um objeto público simples. example: archived: false createdAt: '2019-10-30T03:30:17.883Z' id: '512' properties: property_checkbox: 'false' property_date: '1572480000000' property_dropdown: choice_b property_multiple_checkboxes: chocolate;strawberry property_number: '17' property_radio: option_1 property_string: value updatedAt: '2019-12-07T16:50:06.678Z' Error: required: - category - correlationId - message type: object properties: category: type: string description: A categoria de erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: >- {invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]} correlationId: type: string description: >- Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte format: uuid example: aeb5f871-7f07-4993-9211-075dc63e7cbf errors: type: array description: mais informações sobre o erro items: $ref: '#/components/schemas/ErrorDetail' links: type: object additionalProperties: type: string description: >- Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado example: An error occurred subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa uma resposta de erro retornada pela API quando uma operação falha. Este componente é usado em vários endpoints para fornecer informações detalhadas sobre o erro encontrado. example: message: Invalid input (details will vary based on the error) correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf category: VALIDATION_ERROR links: knowledge-base: https://www.hubspot.com/products/service/knowledge-base Filter: required: - operator - propertyName type: object properties: highValue: type: string description: O valor de limite superior ao usar filtros baseados em intervalo. operator: type: string description: nulo enum: - BETWEEN - CONTAINS_TOKEN - EQ - GT - GTE - HAS_PROPERTY - IN - LT - LTE - NEQ - NOT_CONTAINS_TOKEN - NOT_HAS_PROPERTY - NOT_IN propertyName: type: string description: O nome da propriedade à qual o filtro será aplicado. value: type: string description: O valor a ser comparado com a propriedade. values: type: array description: Os valores a serem comparados com a propriedade. items: type: string description: >- Define uma única condição para pesquisar objetos do CRM, especificando a propriedade a ser filtrada, o operador a ser usado (como igual a, maior que ou contém) e o(s) valor(es) a ser(em) comparado(s). NextPage: required: - after type: object properties: after: type: string description: Um token de cursor de paginação para recuperar páginas subsequentes. link: type: string description: >- Um URL que pode ser usado para recuperar os resultados da próxima página. description: >- Especifica as informações de paginação necessárias para recuperar o próximo conjunto de resultados em uma resposta de API paginada example: after: NTI1Cg%3D%3D link: '?after=NTI1Cg%3D%3D' PreviousPage: required: - before type: object properties: before: type: string description: Um token de cursor de paginação para recuperar páginas anteriores. link: type: string description: >- Um URL que pode ser usado para recuperar os resultados das páginas anteriores. description: >- especifica as informações de paginação necessárias para recuperar o conjunto anterior de resultados em uma resposta de API paginada ValueWithTimestamp: required: - sourceType - timestamp - value type: object properties: sourceId: type: string description: O ID exclusivo da propriedade. sourceLabel: type: string description: Um rótulo legível por humanos. sourceType: type: string description: O tipo de propriedade. timestamp: type: string description: >- A data e hora em que a propriedade foi atualizada, no formato ISO 8601. format: date-time updatedByUserId: type: integer description: O ID do usuário que atualizou a propriedade pela última vez. format: int32 value: type: string description: O valor da propriedade. description: Modelo de propriedade que inclui data e hora. PublicObjectWarning: required: - category - context - message type: object properties: category: type: string description: >- A classificação do aviso, indicando o tipo ou a natureza do problema. context: type: object additionalProperties: type: string description: >- Informações adicionais ou metadados sobre o aviso, fornecendo contexto para entender o problema. message: type: string description: >- O texto da mensagem de aviso, fornecendo informações sobre o problema ou alerta. description: >- Representa uma mensagem de aviso relacionada a um objeto público no HubSpot, fornecendo detalhes sobre a natureza e o contexto do aviso. ErrorDetail: required: - message type: object properties: code: type: string description: O código de status associado ao detalhe do erro context: type: object additionalProperties: type: array items: type: string description: Contexto sobre a condição do erro example: '{missingScopes=[scope1, scope2]}' in: type: string description: O nome do campo ou parâmetro no qual o erro foi encontrado. message: type: string description: >- Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado subCategory: type: string description: >- Uma categoria específica que contém mais detalhes específicos sobre o erro description: >- Representa informações detalhadas sobre um erro ocorrido na API. Este componente é usado para fornecer contexto e detalhes adicionais sobre os erros, geralmente como parte de uma resposta de erro. responses: Error: description: An error occurred. content: '*/*': schema: $ref: '#/components/schemas/Error' ````