Récupérer une définition de champ par clé

curl --request GET \
  --url https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Authorizations

Authorization

string

header

required

Use the access_token returned by POST /v1/auth/token. Do not send the raw API secret on business endpoints.

Headers

X-Request-ID

string

Partner-generated correlation identifier echoed in logs and error payloads.

Path Parameters

field_key

string

required

Paramètre field_key pour cette route; type, format et contraintes ci-dessous.

Response

Successful response

string<uuid>

required

Identifiant MARKO de la ressource.

field_key

string

required

Clé stable de la propriété métier.

table_name

string

required

Nom de la table associée à la propriété métier.

column_name

string

required

Nom de la colonne de stockage associée à la propriété métier.

label_fr

string

required

Libellé français de la propriété métier.

value_type

enum<string>

required

Type métier de la propriété, distinct du type JSON de son enveloppe.

Available options:

texte,

nombre,

decimal,

pourcentage,

montant,

date,

booleen,

enum,

jsonb,

email,

telephone,

surface,

lien_doc,

liste_deroulante

importance

enum<string>

required

Importance attribuée à cette propriété dans le référentiel métier.

Available options:

essentielle,

utile,

optionnelle,

onboarding

is_required

boolean

required

Indique si cette propriété est requise dans le référentiel métier; distinct des champs obligatoires du corps HTTP.

source_type

enum<string>

required

Type de source de l'événement ou de la propriété métier.

Available options:

document,

calculation,

hybrid,

manual,

external

alert_1_enabled

boolean

required

Indique si la règle d'alerte est activée.

alert_2_enabled

boolean

required

Indique si la règle d'alerte est activée.

name_modifiable

boolean

required

Indique si le nom de la propriété peut être modifié dans le référentiel.

value_modifiable

boolean

required

Indique si la valeur de la propriété peut être modifiée.

requires_human_validation

boolean

required

Indique si les valeurs extraites de cette propriété requièrent une validation humaine.

version

integer

required

Version de la ressource MARKO.

created_at

string<date-time>

required

Date de création au format ISO 8601.

updated_at

string<date-time>

required

Date de dernière modification au format ISO 8601.

description

string | null

Explication métier de la propriété.

verticale

string | null

Verticale métier à laquelle cette propriété s'applique.

page_onglet

string | null

Onglet de l'interface auquel la propriété est rattachée.

section

string | null

Section d'affichage de la propriété métier.

ordre_affichage

integer | null

Position de la propriété dans son groupe d'affichage.

enum_values

Enum Values · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

validation_regex

string | null

Expression régulière définie pour valider cette propriété métier.

validation_min

string | null

Valeur minimale définie pour cette propriété métier.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

validation_max

string | null

Valeur maximale définie pour cette propriété métier.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

unit

string | null

Unité de la propriété dans le référentiel métier; la lire avant de convertir une valeur.

sources_dette_mezz

Sources Dette Mezz · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

sources_equity_minoritaire

Sources Equity Minoritaire · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

sources_dette_senior

Sources Dette Senior · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

sources_equity_majoritaire

Sources Equity Majoritaire · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

sources_mix

Sources Mix · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

source_priority

Source Priority · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

calculation_formula

string | null

Formule de calcul déclarée pour cette propriété.

calculation_dependencies

string[] | null

Champs nécessaires au calcul de cette propriété métier.

calculation_trigger

string | null

Événement ou mode qui déclenche le calcul de cette propriété.

alert_1_rule

string | null

Condition de déclenchement de la règle d'alerte.

alert_1_type

enum<string> | null

Type d'alerte associé à la règle.

Available options:

interne,

externe

alert_1_severity

string | null

Gravité de l'alerte déclenchée par la règle.

alert_1_task

string | null

Configuration de la tâche associée à la règle d'alerte.

alert_2_rule

string | null

Condition de déclenchement de la règle d'alerte.

alert_2_type

enum<string> | null

Type d'alerte associé à la règle.

Available options:

interne,

externe

alert_2_severity

string | null

Gravité de l'alerte déclenchée par la règle.

alert_2_task

string | null

Configuration de la tâche associée à la règle d'alerte.

alert_config

Alert Config · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

risk_factor

string | null

Facteur de risque associé à cette propriété métier.

risk_weight

string | null

Poids de cette propriété dans l'évaluation du risque.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

extraction_hints

Extraction Hints · object | null

Objet JSON extensible. Les types des valeurs sont indiqués par additionalProperties lorsque la route les contraint.

extraction_confidence_threshold

string | null

Seuil de confiance configuré pour l'extraction de cette propriété.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

⌘I

Récupérer une définition de champ par clé

curl --request GET \
  --url https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const url = 'https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://partner-api.marko.fr/v1/field-definitions/by-key/{field_key}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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"
}

{
  "type": "about:blank",
  "title": "Unauthorized",
  "status": 401,
  "detail": "A valid bearer token is required.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "The API key does not allow this operation.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "The request payload or parameters are invalid.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "The request rate limit was exceeded.",
  "request_id": "req_example_partner_call"
}

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "An unexpected server error occurred.",
  "request_id": "req_example_partner_call"
}

Démarrer

Tutoriels

Intégrer

Référence API

Récupérer une définition de champ par clé

Authorizations

Headers

Path Parameters

Response