> ## 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 les paramètres de l'entité > Expose les paramètres métier et branding de l'entité. **Scope requis :** `settings:read`. [Scopes et délégation](/scopes-and-delegation). ## OpenAPI ````yaml /openapi.json get /settings 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 `. 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: /settings: get: tags: - settings summary: Lire les paramètres de l'entité description: >- Expose les paramètres métier et branding de l'entité. **Scope requis :** `settings:read`. [Scopes et délégation](/scopes-and-delegation). operationId: settings_get parameters: - in: header name: X-Request-ID required: false description: >- Partner-generated correlation identifier echoed in logs and error payloads. schema: type: string example: marko-settings-get responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/EntityAdminSettingsResponse' example: id: 11111111-1111-1111-1111-111111111111 name: Clubfunding type: example mode_reporting: trimestriel frequence_reporting: 3 risk_threshold: 75 portfolio_goals: {} ai_enabled: true '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: EntityAdminSettingsResponse: properties: id: type: string 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. type: type: string title: Type description: Type de l'entité MARKO. siren: anyOf: - type: string - type: 'null' title: Siren description: >- SIREN français sur 9 chiffres; le service vérifie aussi le checksum lorsque la route le prévoit. mode_reporting: type: string title: Mode Reporting description: Mode de reporting configuré pour l'entité. frequence_reporting: type: integer title: Frequence Reporting description: Fréquence de reporting configurée pour l'entité. date_reference_reporting: anyOf: - type: string format: date - type: 'null' title: Date Reference Reporting description: Date de référence utilisée par le reporting de l'entité. risk_threshold: type: integer title: Risk Threshold default: 60 description: Seuil de risque configuré pour l'entité. zone_vacances: type: string title: Zone Vacances default: C description: Zone de vacances configurée pour la planification de l'entité. portfolio_goals: additionalProperties: true type: object title: Portfolio Goals description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. report_external_neutrality: type: boolean title: Report External Neutrality default: true description: Paramètre de neutralité du reporting externe de l'entité. logo_url: anyOf: - type: string - type: 'null' title: Logo Url description: URL du logo de l'entité. primary_color: anyOf: - type: string - type: 'null' title: Primary Color description: Couleur principale de la marque de l'entité. secondary_color: anyOf: - type: string - type: 'null' title: Secondary Color description: Couleur secondaire de la marque de l'entité. brand_baseline: anyOf: - type: string - type: 'null' title: Brand Baseline description: Texte de signature associé à la marque de l'entité. email_brand_name: anyOf: - type: string - type: 'null' title: Email Brand Name description: Nom de marque utilisé dans les e-mails de l'entité. email_from_address: anyOf: - type: string format: email - type: 'null' title: Email From Address description: Adresse d'expédition configurée pour les e-mails. email_reply_to: anyOf: - type: string format: email - type: 'null' title: Email Reply To description: Adresse proposée pour répondre aux e-mails. email_branding_mode: type: string enum: - marko - co_branded - white_label title: Email Branding Mode default: marko description: Mode de personnalisation des e-mails. email_branding_version: type: integer title: Email Branding Version default: 1 description: Version de la configuration de marque des e-mails. email_sending_domain_status: type: string title: Email Sending Domain Status default: not_configured description: État de validation du domaine d'expédition. email_sending_domain: anyOf: - type: string - type: 'null' title: Email Sending Domain description: Domaine d'expédition configuré pour l'entité. ai_enabled: type: boolean title: Ai Enabled default: true description: >- Indique si les fonctions IA sont activées pour l'entité; les droits de la clé restent requis. manual_creation_policy: $ref: '#/components/schemas/ManualCreationPolicy' default: operation: true fond: true spv: true operateur: true follow_up: true description: Politique de création manuelle par famille de ressources. type: object required: - id - name - type - mode_reporting - frequence_reporting - portfolio_goals title: EntityAdminSettingsResponse description: Entity settings response. 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. ManualCreationPolicy: properties: operation: type: boolean title: Operation default: true description: Politique de création manuelle des opérations. fond: type: boolean title: Fond default: true description: Politique de création manuelle des fonds. spv: type: boolean title: Spv default: true description: Politique de création manuelle des SPV. operateur: type: boolean title: Operateur default: true description: Politique de création manuelle des opérateurs. follow_up: type: boolean title: Follow Up default: true description: Politique de création manuelle des notes de suivi. additionalProperties: false type: object title: ManualCreationPolicy 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.