Lister les pièces justificatives

GET/v1/supporting-documents

Du plus récent au plus ancien. Chaque lecture d’une pièce est tracée.

Droit de clé restreinte : claims:read.

Paramètres de requête

statusénumération
Retient les objets dans cet état.
draftattachedsentacknowledgedrejectedpaper
claimtexte
Les pièces d'une feuille, clm_….
batchtexte
Les pièces d'un lot de pièces, sdb_….
limitentier
Le nombre d'objets rendus, de 1 à 100. Par défaut, 25.
starting_aftertexte
Un identifiant : la page qui suit cet objet.
ending_beforetexte
Un identifiant : la page qui précède cet objet.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl https://api.ophelix.fr/v1/supporting-documents?limit=3 \
  -H "Authorization: Bearer sk_test_…"

PHP


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

TypeScript


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

Réponse 200


{
  "object": "list",
  "url": "https://exemple.fr/hook",
  "has_more": true,
  "data": [
    {
      "id": "obj_…",
      "object": "supporting_document",
      "status": "draft",
      "nature": "prescription",
      "claims": [
        "…"
      ],
      "practitioner": null,
      "identifier": null,
      "file_name": null,
      "source_type": "…",
      "size_bytes": 0,
      "page_count": 0,
      "prescriber": null,
      "prescribed_on": null,
      "batch": null,
      "rejection_code": null,
      "rejection_label": null,
      "digitized_at": null,
      "attached_at": null,
      "sent_at": null,
      "acknowledged_at": null,
      "livemode": false,
      "created": 1793970000
    }
  ]
}