Catalogue de nœuds

Les routes sont relatives à <PUBLIC_BASE_URL> ; les corps de requête et de réponse sont en JSON sauf mention contraire. L’authentification, les portées, la pagination et le format des erreurs sont décrits dans les guides de l’API REST.

GET /api/v1/nodes

Lister les types de nœuds que je peux utiliser

Les types de nœuds autorisés pour l’appelant, après la politique de l’organisation et le rôle : un nœud réservé aux administrateurs disparaît pour un membre ordinaire. Le catalogue lui-même est embarqué côté client.

Accès — Session de membre ou clé d’API portant workflows:read.

Réponses

200 — Les types autorisés.

Champ	Type	Requis
types	string[]	oui

Schéma JSON

{
  "type": "object",
  "properties": { "types": { "type": "array", "items": { "type": "string" } } },
  "required": [ "types" ],
  "additionalProperties": false
}

401 — Aucune session ni clé d’API valide (auth.unauthenticated).

403 — Refusé : rôle insuffisant (auth.forbidden), portée manquante (api_key.scope_missing, details.required la nomme) ou route fermée aux clés (api_key.session_required).

429 — La clé d’API dépasse son débit (api_key.rate_limited) ; Retry-After dit quand réessayer.

GET /api/v1/nodes/resources/{resource}

Énumérer les valeurs d’une ressource de nœud

Une seule route pour tous les resourceLocator du catalogue (dossiers de mail, signatures, membres, dossiers Drive…), paginée par curseur et filtrable par q. Certaines ressources exigent un contexte : mailboxId ou credentialId, sinon 400 resource.context_required ; un contexte qui n’est pas celui du membre est 404 resource.context_not_found. Un fournisseur distant qui échoue est 502 resource.unavailable, un état temporaire qui mérite un nouvel essai.

Accès — Session de membre ou clé d’API portant workflows:read.

Paramètres

Nom	Où	Type	Requis
resource	chemin	string	oui
q	requête	string	non
cursor	requête	string	non
limit	requête	integer	non
mailboxId	requête	string	non
credentialId	requête	string	non
parentId	requête	string	non
parentIds	requête	string | string[]	non

Réponses

200 — Une page de valeurs.

Champ	Type	Requis
items	object[]	oui
nextCursor	string | null	oui

Schéma JSON

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": { "type": "string", "minLength": 1 },
          "label": { "type": "string" },
          "description": { "type": "string" }
        },
        "required": [ "id", "label" ],
        "additionalProperties": false
      }
    },
    "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }
  },
  "required": [ "items", "nextCursor" ],
  "additionalProperties": false
}

400 — La requête ne respecte pas son schéma.

401 — Aucune session ni clé d’API valide (auth.unauthenticated).

403 — Refusé : rôle insuffisant (auth.forbidden), portée manquante (api_key.scope_missing, details.required la nomme) ou route fermée aux clés (api_key.session_required).

429 — La clé d’API dépasse son débit (api_key.rate_limited) ; Retry-After dit quand réessayer.

Codes d’erreur — request.bad_request, resource.unknown, resource.context_required, resource.context_not_found, resource.unavailable. Les codes communs (request.bad_request, auth.unauthenticated, api_key.scope_missing, api_key.rate_limited…) s’appliquent à toutes les routes ; voir Erreurs.