> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.fr/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.

> Recherchez des transactions à l'aide de critères et de filtres spécifiés.

> **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: Transactions
  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: >-
    Lorsqu'un représentant commercial commence à travailler avec un client
    potentiel, créez une fiche d'informations de transaction pour suivre le
    processus de négociation. Lorsque le client effectue ensuite son achat, vous
    pouvez actualiser la transaction à une phase fermée.
  x-hubspot-related-documentation:
    - name: Deals Guide
      url: https://developers.hubspot.com/docs/guides/api/crm/objects/deals
  x-hubspot-introduction: >-
    Utilisez l'API des transactions pour créer et gérer des fiches
    d'informations CRM qui représentent des transactions avec des contacts et/ou
    des entreprises. Les transactions progressent à travers les étapes du
    pipeline pour refléter si la transaction a été complétée, est active, ou a
    été perdue.
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: >-
        Recherchez des transactions à l'aide de différents filtres et critères
        pour récupérer des fiches d'informations spécifiques.
      description: >-
        Recherchez des transactions à l'aide de critères et de filtres
        spécifiés.
      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: >-
            Un jeton de curseur de pagination pour récupérer les pages
            suivantes.
        filterGroups:
          type: array
          description: "Jusqu'à 6\_groupes de filtres définissant des critères d'interrogation supplémentaires."
          items:
            $ref: '#/components/schemas/FilterGroup'
        limit:
          type: integer
          description: "Le nombre maximum de résultats à renvoyer, jusqu'à 200\_objets."
          format: int32
        properties:
          type: array
          description: Une liste de noms de propriétés à inclure dans la réponse.
          items:
            type: string
        query:
          type: string
          description: "La chaîne de requête de la recherche, jusqu'à 3\_000\_caractères."
        sorts:
          type: array
          description: Spécifie l'ordre de tri basé sur les propriétés de l'objet.
          items:
            type: string
      description: Décrit une demande de recherche
    CollectionResponseWithTotalSimplePublicObject:
      required:
        - results
        - total
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          description: >-
            Un tableau contenant les objets publics simples renvoyés dans la
            page actuelle de la réponse. Cette propriété est obligatoire.
          items:
            $ref: '#/components/schemas/SimplePublicObject'
        total:
          type: integer
          description: Le nombre de résultats disponibles
          format: int32
      description: >-
        Représente une liste d'objets simples renvoyés par une requête API,
        ainsi que le nombre total d'objets disponibles.
    FilterGroup:
      required:
        - filters
      type: object
      properties:
        filters:
          type: array
          description: >-
            Une liste de critères de filtre individuels qui sont appliqués
            ensemble en tant que groupe. Chaque filtre spécifie une condition
            que les fiches d'informations doivent remplir pour être incluses
            dans les résultats.
          items:
            $ref: '#/components/schemas/Filter'
      description: >-
        Représente un groupe de filtres utilisés pour interroger des données
        dans HubSpot. Ce composant est utilisé pour définir des critères de
        filtrage des fiches d'informations dans divers points de terminaison
        d'API.
    Paging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
        prev:
          $ref: '#/components/schemas/PreviousPage'
      description: >-
        Représente les informations de pagination pour naviguer dans une liste
        de résultats de l'API. Il fournit des détails sur la manière d'accéder à
        l'ensemble de résultats précédent ou suivant.
    SimplePublicObject:
      required:
        - archived
        - createdAt
        - id
        - properties
        - updatedAt
      type: object
      properties:
        archived:
          type: boolean
          description: Si l'objet est archivé.
        archivedAt:
          type: string
          description: "L'horodatage du moment où l'objet a été archivé, au format ISO\_8601."
          format: date-time
        createdAt:
          type: string
          description: "L'horodatage du moment où l'objet a été créé, au format ISO\_8601."
          format: date-time
        id:
          type: string
          description: L'ID unique de l'objet.
        objectWriteTraceId:
          type: string
          description: >-
            Un identifiant permettant de suivre la demande de création ou de
            mise à jour de l'objet.
        properties:
          type: object
          additionalProperties:
            type: string
          description: Paires clé-valeur représentant les propriétés de l'objet.
        propertiesWithHistory:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ValueWithTimestamp'
          description: >-
            Paires clé-valeur représentant les propriétés de l'objet avec leur
            historique.
        updatedAt:
          type: string
          description: "L'horodatage du moment où l'objet a été mis à jour pour la dernière fois, au format ISO\_8601."
          format: date-time
        url:
          type: string
          description: L'URL associée à l'objet.
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/PublicObjectWarning'
      description: Un objet public 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 catégorie d'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identifiant unique pour la demande. Incluez cette valeur dans
            tous les rapports d'erreurs ou tickets d'assistance
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: informations supplémentaires à propos de l'erreur
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés contenant de la
            documentation sur l'erreur ou les mesures correctives recommandées
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération
        échoue. Ce composant est utilisé dans divers points de terminaison pour
        fournir des informations détaillées sur l'erreur rencontrée.
      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: >-
            Valeur limite supérieure lors de l'utilisation de filtres basés sur
            la portée.
        operator:
          type: string
          description: non valide
          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: Le nom de la propriété à laquelle appliquer le filtre.
        value:
          type: string
          description: La valeur à comparer à la propriété.
        values:
          type: array
          description: Les valeurs à comparer à la propriété.
          items:
            type: string
      description: "Définit une condition unique pour la recherche d'objets CRM, en spécifiant la propriété sur laquelle filtrer, l'opérateur à utiliser (tel que «\_égal à\_», «\_supérieur à\_» ou «\_contient\_») et la ou les valeurs à comparer. "
    NextPage:
      required:
        - after
      type: object
      properties:
        after:
          type: string
          description: >-
            Un jeton de curseur de pagination pour récupérer les pages
            suivantes.
        link:
          type: string
          description: >-
            Une URL qui peut être utilisée pour récupérer les résultats de la
            page suivante.
      description: >-
        Spécifie les informations de pagination nécessaires pour récupérer le
        prochain ensemble de résultats dans une réponse d'API paginée
      example:
        after: NTI1Cg%3D%3D
        link: '?after=NTI1Cg%3D%3D'
    PreviousPage:
      required:
        - before
      type: object
      properties:
        before:
          type: string
          description: >-
            Un jeton de curseur de pagination pour récupérer les pages
            précédentes.
        link:
          type: string
          description: >-
            Une URL qui peut être utilisée pour récupérer les résultats des
            pages précédentes.
      description: >-
        spécifie les informations de pagination nécessaires pour récupérer
        l'ensemble de résultats précédent dans une réponse d'API paginée
    ValueWithTimestamp:
      required:
        - sourceType
        - timestamp
        - value
      type: object
      properties:
        sourceId:
          type: string
          description: L'ID unique de la propriété.
        sourceLabel:
          type: string
          description: Un libellé lisible par l'homme.
        sourceType:
          type: string
          description: Le type de propriété.
        timestamp:
          type: string
          description: "Date à laquelle la propriété a été mise à jour, au format ISO\_8601."
          format: date-time
        updatedByUserId:
          type: integer
          description: >-
            L'ID de l'utilisateur qui a mis à jour la propriété pour la dernière
            fois.
          format: int32
        value:
          type: string
          description: La valeur de la propriété.
      description: Modèle de propriété qui inclut un horodatage.
    PublicObjectWarning:
      required:
        - category
        - context
        - message
      type: object
      properties:
        category:
          type: string
          description: >-
            La classification de l'avertissement, indiquant le type ou la nature
            du problème.
        context:
          type: object
          additionalProperties:
            type: string
          description: >-
            Informations supplémentaires ou métadonnées concernant
            l'avertissement, fournissant un contexte pour la compréhension du
            problème.
        message:
          type: string
          description: >-
            Le texte du message d'avertissement, fournissant des informations
            sur le problème ou l'alerte.
      description: >-
        Représente un message d'avertissement lié à un objet public dans
        HubSpot, fournissant des détails sur la nature et le contexte de
        l'avertissement.
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: Le code du statut associé au détail de l'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée.
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente des informations détaillées sur une erreur survenue dans
        l'API. Ce composant est utilisé pour fournir un contexte et des
        spécificités supplémentaires sur les erreurs, généralement dans le cadre
        d'une réponse d'erreur.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'

````