Lire un lot de pièces

GET/v1/supporting-document-batches/{supportingDocumentBatch}

Droit de clé restreinte : batches:read.

Paramètres de chemin

supportingDocumentBatchtexteobligatoire
L'identifiant, sdb_….

Réponse

Rend l’objet lots de pièces.

Une erreur suit le format commun.

Requête

curl


curl https://api.ophelix.fr/v1/supporting-document-batches/sdb_… \
  -H "Authorization: Bearer sk_test_…"

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->get('/v1/supporting-document-batches/sdb_…', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/supporting-document-batches/sdb_…', {
  headers: { Authorization: 'Bearer sk_test_…' },
})
const object = await response.json()

Réponse 200


{
  "id": "obj_…",
  "object": "supporting_document_batch",
  "status": "created",
  "name": "Accueil",
  "batch": null,
  "practitioner": "…",
  "sequence": 0,
  "sequence_count": 0,
  "dossier_count": 0,
  "document_count": 0,
  "recipient": null,
  "file_name": null,
  "size_bytes": null,
  "retransmission": true,
  "failure_code": null,
  "failure_label": null,
  "sent_at": null,
  "acknowledged_at": null,
  "failed_at": null,
  "livemode": false,
  "created": 1793970000
}