> ## 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. # Récupérer une définition de champ par clé > Retourne la définition détaillée d'un champ métier par field_key. **Scope requis :** `operations:read`. [Scopes et délégation](/scopes-and-delegation). ## OpenAPI ````yaml /openapi.json get /field-definitions/by-key/{field_key} 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: /field-definitions/by-key/{field_key}: get: tags: - field-definitions summary: Récupérer une définition de champ par clé description: >- Retourne la définition détaillée d'un champ métier par field_key. **Scope requis :** `operations:read`. [Scopes et délégation](/scopes-and-delegation). operationId: field-definitions_by-key parameters: - in: path name: field_key required: true schema: type: string title: Field Key example: montant_pret description: >- Paramètre field_key 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-field-definitions-by-key responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/FieldDefinitionResponse' example: id: 11111111-1111-1111-1111-111111111111 field_key: montant_pret table_name: example column_name: example label_fr: Montant du prêt value_type: texte importance: essentielle is_required: false source_type: document alert_1_enabled: false alert_2_enabled: false name_modifiable: false value_modifiable: false requires_human_validation: false version: 0 created_at: '2026-10-01T10:00:00Z' updated_at: '2026-10-01T10:00:00Z' '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: FieldDefinitionResponse: properties: id: type: string format: uuid title: Id description: Identifiant MARKO de la ressource. field_key: type: string title: Field Key description: Clé stable de la propriété métier. table_name: type: string title: Table Name description: Nom de la table associée à la propriété métier. column_name: type: string title: Column Name description: Nom de la colonne de stockage associée à la propriété métier. label_fr: type: string title: Label Fr description: Libellé français de la propriété métier. description: anyOf: - type: string - type: 'null' title: Description description: Explication métier de la propriété. verticale: anyOf: - type: string - type: 'null' title: Verticale description: Verticale métier à laquelle cette propriété s'applique. page_onglet: anyOf: - type: string - type: 'null' title: Page Onglet description: Onglet de l'interface auquel la propriété est rattachée. section: anyOf: - type: string - type: 'null' title: Section description: Section d'affichage de la propriété métier. ordre_affichage: anyOf: - type: integer - type: 'null' title: Ordre Affichage description: Position de la propriété dans son groupe d'affichage. value_type: $ref: '#/components/schemas/FieldValueType' description: Type métier de la propriété, distinct du type JSON de son enveloppe. enum_values: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Enum Values description: >- Valeurs proposées pour cette propriété métier lorsqu'elle possède un choix fermé. validation_regex: anyOf: - type: string - type: 'null' title: Validation Regex description: Expression régulière définie pour valider cette propriété métier. validation_min: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Validation Min description: Valeur minimale définie pour cette propriété métier. validation_max: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Validation Max description: Valeur maximale définie pour cette propriété métier. unit: anyOf: - type: string - type: 'null' title: Unit description: >- Unité de la propriété dans le référentiel métier; la lire avant de convertir une valeur. importance: $ref: '#/components/schemas/FieldImportance' description: Importance attribuée à cette propriété dans le référentiel métier. is_required: type: boolean title: Is Required description: >- Indique si cette propriété est requise dans le référentiel métier; distinct des champs obligatoires du corps HTTP. source_type: $ref: '#/components/schemas/FieldSourceType' description: Type de source de l'événement ou de la propriété métier. sources_dette_mezz: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Sources Dette Mezz description: >- Sources documentaires prévues pour cette propriété en dette mezzanine. sources_equity_minoritaire: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Sources Equity Minoritaire description: >- Sources documentaires prévues pour cette propriété en equity minoritaire. sources_dette_senior: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Sources Dette Senior description: Sources documentaires prévues pour cette propriété en dette senior. sources_equity_majoritaire: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Sources Equity Majoritaire description: >- Sources documentaires prévues pour cette propriété en equity majoritaire. sources_mix: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Sources Mix description: >- Sources documentaires prévues pour cette propriété dans un investissement mixte. source_priority: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Source Priority description: Ordre de priorité des sources de cette propriété métier. calculation_formula: anyOf: - type: string - type: 'null' title: Calculation Formula description: Formule de calcul déclarée pour cette propriété. calculation_dependencies: anyOf: - type: array items: type: string - type: 'null' title: Calculation Dependencies description: Champs nécessaires au calcul de cette propriété métier. calculation_trigger: anyOf: - type: string - type: 'null' title: Calculation Trigger description: Événement ou mode qui déclenche le calcul de cette propriété. alert_1_enabled: type: boolean title: Alert 1 Enabled description: Indique si la règle d'alerte est activée. alert_1_rule: anyOf: - type: string - type: 'null' title: Alert 1 Rule description: Condition de déclenchement de la règle d'alerte. alert_1_type: anyOf: - $ref: '#/components/schemas/AlertSourceType' - type: 'null' description: Type d'alerte associé à la règle. alert_1_severity: anyOf: - type: string - type: 'null' title: Alert 1 Severity description: Gravité de l'alerte déclenchée par la règle. alert_1_task: anyOf: - type: string - type: 'null' title: Alert 1 Task description: Configuration de la tâche associée à la règle d'alerte. alert_2_enabled: type: boolean title: Alert 2 Enabled description: Indique si la règle d'alerte est activée. alert_2_rule: anyOf: - type: string - type: 'null' title: Alert 2 Rule description: Condition de déclenchement de la règle d'alerte. alert_2_type: anyOf: - $ref: '#/components/schemas/AlertSourceType' - type: 'null' description: Type d'alerte associé à la règle. alert_2_severity: anyOf: - type: string - type: 'null' title: Alert 2 Severity description: Gravité de l'alerte déclenchée par la règle. alert_2_task: anyOf: - type: string - type: 'null' title: Alert 2 Task description: Configuration de la tâche associée à la règle d'alerte. alert_config: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Alert Config description: Configuration des règles d'alerte associées à ce champ métier. name_modifiable: type: boolean title: Name Modifiable description: >- Indique si le nom de la propriété peut être modifié dans le référentiel. value_modifiable: type: boolean title: Value Modifiable description: Indique si la valeur de la propriété peut être modifiée. risk_factor: anyOf: - type: string - type: 'null' title: Risk Factor description: Facteur de risque associé à cette propriété métier. risk_weight: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Risk Weight description: Poids de cette propriété dans l'évaluation du risque. extraction_hints: anyOf: - additionalProperties: true type: object description: >- Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint. - type: 'null' title: Extraction Hints description: >- Indications destinées à l'extraction de cette propriété depuis les documents. extraction_confidence_threshold: anyOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' title: Extraction Confidence Threshold description: Seuil de confiance configuré pour l'extraction de cette propriété. requires_human_validation: type: boolean title: Requires Human Validation description: >- Indique si les valeurs extraites de cette propriété requièrent une validation humaine. version: type: integer title: Version description: Version de la ressource MARKO. 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 - field_key - table_name - column_name - label_fr - value_type - importance - is_required - source_type - alert_1_enabled - alert_2_enabled - name_modifiable - value_modifiable - requires_human_validation - version - created_at - updated_at title: FieldDefinitionResponse 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. FieldValueType: type: string enum: - texte - nombre - decimal - pourcentage - montant - date - booleen - enum - jsonb - email - telephone - surface - lien_doc - liste_deroulante title: FieldValueType description: Type de valeur d'un champ. FieldImportance: type: string enum: - essentielle - utile - optionnelle - onboarding title: FieldImportance description: Importance du champ. FieldSourceType: type: string enum: - document - calculation - hybrid - manual - external title: FieldSourceType description: Source d'un champ. AlertSourceType: type: string enum: - interne - externe title: AlertSourceType description: Type de source d'alerte. 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.