> ## Documentation Index
> Fetch the complete documentation index at: https://developers.marko.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Lister les deals

> Expose le pipeline CRM pre-closing de l'entité.

**Scope requis :** `deals:read`. [Scopes et délégation](/scopes-and-delegation).



## OpenAPI

````yaml /openapi.json get /deals
openapi: 3.1.0
info:
  title: MARKO External Partner API
  version: v1
  description: >-
    Stable external API contract for the live environment.


    Authentication flow for partner integrations:

    1. Generate an API key from the MARKO entity admin API section.

    2. Keep the raw API secret server-side and use it only to sign `POST
    /v1/auth/token`.

    3. Build the canonical message
    `MARKO-EXTERNAL-API-TOKEN-V1\n{key_id}\n{timestamp}\n{nonce}`.

    4. Sign that message with HMAC-SHA256 and send the hex signature with
    `key_id`, `timestamp` and `nonce`.

    5. Use the returned short-lived bearer on business endpoints as
    `Authorization: Bearer <access_token>`.

    The raw API secret must never be sent on business endpoints.


    This public contract intentionally excludes beta endpoints.


    Référence enrichie pour les développeurs et les assistants IA. Exemples
    synthétiques; les champs sont extraits des modèles et sérialiseurs de la
    version indiquée dans x-documentation-provenance.
servers:
  - url: https://partner-api.marko.fr/v1
security:
  - BearerAuth: []
tags:
  - name: auth
    x-group: Authentification
  - name: entity
    x-group: Entité
  - name: portfolio
    x-group: Portefeuille
  - name: deals
    x-group: Deals
  - name: fonds
    x-group: Fonds
  - name: spvs
    x-group: SPV
  - name: operations
    x-group: Opérations
  - name: taxonomies
    x-group: Taxonomies
  - name: import-jobs
    x-group: Imports par lot
  - name: comments
    x-group: Commentaires
  - name: documents
    x-group: Documents
  - name: users
    x-group: Utilisateurs
  - name: settings
    x-group: Paramètres
  - name: rcci
    x-group: Conformité RCCI
  - name: field-definitions
    x-group: Champs métier
  - name: search
    x-group: Recherche
  - name: operateurs
    x-group: Opérateurs
  - name: alerts
    x-group: Alertes
  - name: notifications
    x-group: Notifications
  - name: calendar
    x-group: Calendrier
  - name: enrichment
    x-group: Enrichissement SIREN
  - name: reports
    x-group: Exports
  - name: reporting
    x-group: Templates de reporting
  - name: workflows
    x-group: Workflows et extraction IA
  - name: tasks
    x-group: Tâches
externalDocs:
  description: Download the matching Postman collection.
  url: /v1/postman.json
paths:
  /deals:
    get:
      tags:
        - deals
      summary: Lister les deals
      description: >-
        Expose le pipeline CRM pre-closing de l'entité.


        **Scope requis :** `deals:read`. [Scopes et
        délégation](/scopes-and-delegation).
      operationId: deals_list
      parameters:
        - in: query
          name: limit
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 20
            title: Limit
          example: 20
          description: >-
            Nombre maximal de résultats sur cette page; bornes et valeur par
            défaut ci-dessous.
        - in: query
          name: offset
          required: false
          schema:
            type: integer
            minimum: 0
            default: 0
            title: Offset
          example: 0
          description: Nombre de résultats à ignorer avant cette page (commence à 0).
        - in: query
          name: status
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/DealStatus'
              - type: 'null'
            description: Filter by deal status
            title: Status
          example: sourcing
          description: Filter by deal status
        - in: header
          name: X-Request-ID
          required: false
          description: >-
            Partner-generated correlation identifier echoed in logs and error
            payloads.
          schema:
            type: string
          example: marko-deals-list
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_DealResponse_'
              example:
                items:
                  - id: 11111111-1111-4111-8111-111111111111
                    name: Pipeline Demo
                    status: sourcing
                    created_at: '2026-10-01T10:00:00Z'
                    updated_at: '2026-10-01T10:00:00Z'
                total: 1
                limit: 0
                offset: 0
        '401':
          description: Authentication required
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: A valid bearer token is required.
                request_id: req_example_partner_call
        '403':
          description: Scope, route or IP restriction
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Forbidden
                status: 403
                detail: The API key does not allow this operation.
                request_id: req_example_partner_call
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Unprocessable Content
                status: 422
                detail: The request payload or parameters are invalid.
                request_id: req_example_partner_call
        '429':
          description: Rate limit or progressive ban
          headers:
            Retry-After:
              description: Cooldown in seconds before retrying the request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: The request rate limit was exceeded.
                request_id: req_example_partner_call
        '500':
          description: Unexpected server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Internal Server Error
                status: 500
                detail: An unexpected server error occurred.
                request_id: req_example_partner_call
      deprecated: false
      security:
        - BearerAuth: []
components:
  schemas:
    DealStatus:
      type: string
      enum:
        - sourcing
        - analyse
        - due_diligence
        - comite
        - closing
        - abandonne
      title: DealStatus
      description: Statut du deal dans le pipeline CRM.
    PaginatedResponse_DealResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/DealResponse'
          type: array
          title: Items
          description: Résultats de la page courante.
        total:
          type: integer
          title: Total
          description: Nombre total de résultats correspondant aux filtres.
        limit:
          type: integer
          title: Limit
          description: Limit used for this request
        offset:
          type: integer
          title: Offset
          description: Nombre de résultats ignorés avant cette page.
        page:
          type: integer
          title: Page
          description: Numéro de la page courante, à partir de 1.
          default: 0
        pages:
          type: integer
          title: Pages
          description: Nombre total de pages pour cette taille de page.
          default: 0
      type: object
      required:
        - items
        - total
        - limit
        - offset
      title: PaginatedResponse[DealResponse]
    ProblemDetails:
      type: object
      required:
        - title
        - status
        - detail
      properties:
        type:
          type: string
          default: about:blank
          description: >-
            URI identifiant le type de problème; about:blank lorsque seul le
            statut HTTP le caractérise.
        title:
          type: string
          description: Titre affiché pour l'événement ou le problème.
        status:
          type: integer
          description: Statut HTTP de la réponse d'erreur.
        detail:
          type: string
          description: Informations détaillées sur le problème ou le dossier.
        request_id:
          type: string
          description: Identifiant de corrélation pour le diagnostic de la requête.
        scope:
          type: string
          description: Scope concerné par le refus d'accès, lorsqu'il est renseigné.
        route_id:
          type: string
          description: Identifiant de la route concernée par le problème.
        reason_code:
          type: string
          description: >-
            Code structuré du motif de refus; préférable au texte du message
            pour le diagnostic.
    DealResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Identifiant MARKO de la ressource.
        name:
          type: string
          title: Name
          description: >-
            Nom de la ressource. Les recherches exactes et partielles sont
            décrites au niveau de la route.
        status:
          $ref: '#/components/schemas/DealStatus'
          description: >-
            Statut du deal dans le pipeline avant closing; distinct du statut
            d'une opération.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description libre de la ressource.
        montant_estime:
          anyOf:
            - type: string
              pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            - type: 'null'
          title: Montant Estime
          description: Montant prévisionnel du deal.
        classe_actif:
          anyOf:
            - type: string
            - type: 'null'
          title: Classe Actif
          description: >-
            Classe d'actif de l'opération. Pour une écriture externe, consulter
            la dimension asset_class de GET /taxonomies.
        operateur_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Operateur Id
          description: UUID MARKO de l'opérateur.
        operation_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Operation Id
          description: UUID MARKO de l'opération.
        responsable:
          anyOf:
            - type: string
            - type: 'null'
          title: Responsable
          description: Responsable déclaré du deal.
        date_sourcing:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Date Sourcing
          description: Date d'entrée du deal dans le pipeline.
        date_closing_prevue:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Date Closing Prevue
          description: Date prévisionnelle du closing du deal.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Date de création au format ISO 8601.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: Date de dernière modification au format ISO 8601.
      type: object
      required:
        - id
        - name
        - status
        - created_at
        - updated_at
      title: DealResponse
      description: Reponse API pour un deal.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: MARKO short-lived bearer
      description: >-
        Use the `access_token` returned by `POST /v1/auth/token`. Do not send
        the raw API secret on business endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.