> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.es/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.
> Buscar negocios utilizando los criterios y filtros especificados.
export const ScopesList = ({scopes = [], description = "Esta API requiere uno de los siguientes ámbitos:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/legacy/v3/crm-deals-v3.json POST /crm/v3/objects/0-3/search
openapi: 3.0.1
info:
title: Negocios
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: >-
Cuando un representante de ventas comienza a trabajar con un prospecto, crea
un registro de negocios para hacer seguimiento del proceso de negociación.
Cuando el cliente más adelante realice su compra, podrás actualizar el
negocio a una etapa de cierre.
x-hubspot-related-documentation:
- name: Deals Guide
url: https://developers.hubspot.com/docs/guides/api/crm/objects/deals
x-hubspot-introduction: >-
Utiliza la API de negocios para crear y gestionar registros del CRM que
representen transacciones con contactos o empresas. Los negocios avanzan a
través de las etapas del pipeline para reflejar si la transacción se hizo,
está activa o se perdió.
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: >-
Buscar negocios utilizando varios filtros y criterios para obtener
registros específicos.
description: Buscar negocios utilizando los criterios y filtros especificados.
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:
- oauth2:
- crm.objects.deals.read
components:
schemas:
PublicObjectSearchRequest:
required:
- after
- filterGroups
- limit
- properties
- sorts
type: object
properties:
after:
type: string
description: >-
Un token del cursor de paginación para recuperar páginas
posteriores.
filterGroups:
type: array
description: >-
Hasta seis grupos de filtros que definen criterios de consulta
adicionales.
items:
$ref: '#/components/schemas/FilterGroup'
limit:
type: integer
description: El número máximo de resultados que se devolverán, hasta 200 objetos.
format: int32
properties:
type: array
description: >-
Una lista de nombres de propiedades que se incluirán en la
respuesta.
items:
type: string
query:
type: string
description: La cadena de texto de la consulta, hasta 3000 caracteres
sorts:
type: array
description: >-
Especifica el orden de clasificación en función de las propiedades
del objeto.
items:
type: string
description: Describe una solicitud de búsqueda
CollectionResponseWithTotalSimplePublicObject:
required:
- results
- total
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
results:
type: array
items:
$ref: '#/components/schemas/SimplePublicObject'
total:
type: integer
description: El número de resultados disponibles
format: int32
description: >-
Representa una lista de objetos simples devueltos de una solicitud a la
API, junto con el total de objetos disponibles.
FilterGroup:
required:
- filters
type: object
properties:
filters:
type: array
items:
$ref: '#/components/schemas/Filter'
Paging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
prev:
$ref: '#/components/schemas/PreviousPage'
SimplePublicObject:
required:
- archived
- createdAt
- id
- properties
- updatedAt
type: object
properties:
archived:
type: boolean
description: Si se archiva o no el objeto.
archivedAt:
type: string
description: >-
La marca de tiempo en la que se archivó el objeto, en formato ISO
8601.
format: date-time
createdAt:
type: string
description: La marca de tiempo en la que se creó el objeto, en formato ISO 8601.
format: date-time
id:
type: string
description: El ID único del objeto
objectWriteTraceId:
type: string
description: >-
Un identificador utilizado para rastrear la solicitud de creación o
actualización del objeto.
properties:
type: object
additionalProperties:
type: string
description: Pares clave-valor que representan las propiedades del objeto.
propertiesWithHistory:
type: object
additionalProperties:
type: array
items:
$ref: '#/components/schemas/ValueWithTimestamp'
description: >-
Pares clave-valor que representan las propiedades del objeto junto
con su historial.
updatedAt:
type: string
description: >-
La marca de tiempo de la última vez que se actualizó el objeto, en
formato ISO 8601.
format: date-time
url:
type: string
description: La URL asociada al objeto.
warnings:
type: array
items:
$ref: '#/components/schemas/PublicObjectWarning'
description: Un objeto público simple.
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: La categoría del error
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Contexto de la condición de error
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
Un identificador único para la solicitud. Incluye este valor con
cualquier informe de error o ticket de asistencia.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: información adicional acerca del error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
Un mapa de nombres de enlaces a las URI asociadas que contienen
documentación sobre el error o los pasos recomendados para
solucionarlo
message:
type: string
description: >-
Un mensaje legible en el que se describa el error y los pasos para
solucionarlo, si procede
example: An error occurred
subCategory:
type: string
description: >-
Una categoría específica que contiene detalles más concretos acerca
del error
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: >-
El valor límite superior cuando se utilizan filtros en función de
rangos.
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: El nombre de la propiedad a la que se aplicará el filtro.
value:
type: string
description: El valor con el que se comparará la propiedad.
values:
type: array
description: El valor con el que se comparará la propiedad.
items:
type: string
description: >-
Define una condición única para buscar objetos del CRM especificando la
propiedad con la cual filtrar, el operador que se usará (como igual a,
mayor que o contiene) y los valores con los que comparar.
NextPage:
required:
- after
type: object
properties:
after:
type: string
description: >-
Un token del cursor de paginación para recuperar páginas
posteriores.
link:
type: string
description: >-
Una URL que se puede utilizar para recuperar los resultados de la
página siguiente.
description: >-
Especifica la información de paginación necesaria para obtener el
siguiente conjunto de resultados en una respuesta paginada de la API
example:
after: NTI1Cg%3D%3D
link: '?after=NTI1Cg%3D%3D'
PreviousPage:
required:
- before
type: object
properties:
before:
type: string
description: Un token del cursor de paginación para recuperar páginas anteriores.
link:
type: string
description: >-
Una URL que se puede utilizar para recuperar los resultados de las
páginas anteriores.
description: >-
especifica la información de paginación necesaria para obtener el
conjunto anterior de resultados en una respuesta paginada de la API
ValueWithTimestamp:
required:
- sourceType
- timestamp
- value
type: object
properties:
sourceId:
type: string
description: El ID único de la propiedad.
sourceLabel:
type: string
description: Una etiqueta legible para humanos.
sourceType:
type: string
description: El tipo de propiedad.
timestamp:
type: string
description: >-
La marca de tiempo en la que se actualizó la propiedad, en formato
ISO 8601.
format: date-time
updatedByUserId:
type: integer
description: El ID del usuario que actualizó la propiedad por última vez.
format: int32
value:
type: string
description: El valor de propiedad
description: Modelo de propiedad que incluye marca de tiempo.
PublicObjectWarning:
required:
- category
- context
- message
type: object
properties:
category:
type: string
context:
type: object
additionalProperties:
type: string
message:
type: string
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: El código de estado asociado al detalle del error
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Contexto de la condición de error
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: El nombre del campo o parámetro en el que se encontró el error.
message:
type: string
description: >-
Un mensaje legible en el que se describa el error y los pasos para
solucionarlo, si procede
subCategory:
type: string
description: >-
Una categoría específica que contiene detalles más concretos acerca
del error
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
crm.objects.commercepayments.read: ''
crm.objects.deals.read: ''
crm.objects.deals.write: ''
oauth: ''
````
{product.name} -
{product.level}
)}