> ## 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.

# Lire un dashboard personnalisé du sujet délégué

> Retourne un dashboard possédé par le sujet utilisateur délégué.

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

**Délégation utilisateur :** exactement un header `X-Marko-Delegated-User-Id` ou `X-Marko-Delegated-User-Email`.

**Accès complémentaire :** allowlist utilisateur explicite sur la clé et capacité `custom_dashboards`. Le sujet doit être approuvé et appartenir à la même entité.



## OpenAPI

````yaml /openapi.json get /users/me/custom-dashboards/{dashboard_id}
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:
  /users/me/custom-dashboards/{dashboard_id}:
    get:
      tags:
        - users
      summary: Lire un dashboard personnalisé du sujet délégué
      description: >-
        Retourne un dashboard possédé par le sujet utilisateur délégué.


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


        **Délégation utilisateur :** exactement un header
        `X-Marko-Delegated-User-Id` ou `X-Marko-Delegated-User-Email`.


        **Accès complémentaire :** allowlist utilisateur explicite sur la clé et
        capacité `custom_dashboards`. Le sujet doit être approuvé et appartenir
        à la même entité.
      operationId: users_custom-dashboards_get
      parameters:
        - in: path
          name: dashboard_id
          required: true
          schema:
            type: string
            format: uuid
            title: Dashboard Id
          example: 22222222-2222-2222-2222-222222222222
          description: >-
            Paramètre dashboard_id pour cette route; type, format et contraintes
            ci-dessous.
        - in: header
          name: X-Request-ID
          required: false
          description: >-
            Partner-generated correlation identifier echoed in logs and error
            payloads.
          schema:
            type: string
          example: marko-users-custom-dashboards-get
        - name: X-Marko-Delegated-User-Id
          in: header
          required: false
          schema:
            type: string
          description: >-
            Fournir exactement un des deux headers de délégation (Id ou Email),
            dans la même entité. Ils sont mutuellement exclusifs. Voir le guide
            Scopes et délégation.
        - name: X-Marko-Delegated-User-Email
          in: header
          required: false
          schema:
            type: string
          description: >-
            Fournir exactement un des deux headers de délégation (Id ou Email),
            dans la même entité. Ils sont mutuellement exclusifs. Voir le guide
            Scopes et délégation.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomDashboardResponse'
              example:
                id: 22222222-2222-2222-2222-222222222222
                name: Pilotage portefeuille
                description: null
                user_id: example
                layout: []
                filters: {}
                is_shared: false
                share_token: null
                created_at: '2026-10-01T10:00:00Z'
                updated_at: '2026-10-01T10:00:00Z'
        '400':
          description: >-
            Bad Request — refus déclaré dans le handler ou un helper de cette
            route.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '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
        '404':
          description: >-
            Not Found — refus déclaré dans le handler ou un helper de cette
            route.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '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:
    CustomDashboardResponse:
      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.
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description libre de la ressource.
        user_id:
          type: string
          title: User Id
          description: Identifiant utilisateur MARKO; il n'est pas nécessairement un UUID.
        layout:
          items:
            additionalProperties: true
            type: object
            description: >-
              Objet JSON extensible. Les types des valeurs sont indiqués par
              additionalProperties lorsque la route les contraint.
          type: array
          title: Layout
          description: Disposition des widgets du dashboard.
        filters:
          additionalProperties: true
          type: object
          title: Filters
          description: >-
            Objet JSON extensible. Les types des valeurs sont indiqués par
            additionalProperties lorsque la route les contraint.
        default_scope:
          $ref: '#/components/schemas/DashboardScope'
          description: Périmètre métier initial du dashboard.
        sharing:
          $ref: '#/components/schemas/DashboardSharing'
          description: Visibilité, permissions et membres du partage du dashboard.
        can_edit:
          type: boolean
          title: Can Edit
          default: false
          description: Indique si l'utilisateur délégué peut modifier ce dashboard.
        can_manage:
          type: boolean
          title: Can Manage
          default: false
          description: >-
            Indique si l'utilisateur délégué peut gérer le partage de ce
            dashboard.
        is_shared:
          type: boolean
          title: Is Shared
          description: Indique si le dashboard est partagé.
        share_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Share Token
          description: >-
            Jeton associé au partage du dashboard, lorsqu'il existe; ne pas le
            publier.
        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
        - description
        - user_id
        - layout
        - filters
        - is_shared
        - share_token
        - created_at
        - updated_at
      title: CustomDashboardResponse
    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.
    DashboardScope:
      properties:
        level:
          type: string
          enum:
            - entity
            - fund
            - operation
          title: Level
          default: entity
          description: Niveau du périmètre métier du dashboard.
        ids:
          items:
            type: string
            format: uuid
          type: array
          maxItems: 500
          title: Ids
          description: Identifiants des ressources incluses dans le périmètre sélectionné.
      additionalProperties: false
      type: object
      title: DashboardScope
    DashboardSharing:
      properties:
        visibility:
          type: string
          enum:
            - private
            - team
            - entity
          title: Visibility
          default: private
          description: Périmètre de visibilité du partage du dashboard.
        permission:
          type: string
          enum:
            - read
            - edit
          title: Permission
          default: read
          description: Niveau de permission accordé par le partage du dashboard.
        member_ids:
          items:
            type: string
          type: array
          maxItems: 64
          title: Member Ids
          description: Identifiants des membres concernés par le partage du dashboard.
      additionalProperties: false
      type: object
      title: DashboardSharing
  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.