B2B (v1)

Envois postaux de votre organisation, du plus récent au plus ancien (pagination par curseur)

get/v1/mailings

Request

  • Base URL: https://api.vitef.com
  • URL: https://api.vitef.com/v1/mailings
  • Auth: HTTP bearer

Query parameters

limitinteger

Nombre d’éléments par page (1 à 100, 20 par défaut).

cursorstring

Curseur opaque : la valeur nextCursor de la page précédente.

referencestring

Votre référence, à l’identique.

status'paid' | 'printed' | 'posted' | 'in_transit' | 'delivered' | 'ar_signed' | 'returned' | 'error' | 'canceled'

Response

Envois

nextCursorstring nullable required

À passer dans cursor pour la page suivante ; null à la dernière page.

hasMoreboolean required

Example response

{
  "data": [
    {
      "id": "a12665a3-43e4-4b50-9593-f489ec2174cd",
      "orderId": null,
      "title": "Lettre de réclamation",
      "mode": "ar",
      "modeLabel": "Recommandé avec AR",
      "status": "delivered",
      "statusLabel": "Distribuée",
      "step": 4,
      "lastStep": 5,
      "trackingNumber": "1A15760000001",
      "createdAt": "2026-09-23T10:00:00.000Z",
      "events": [
        {
          "step": 0,
          "status": "paid",
          "label": "Payée",
          "at": "2026-09-23T10:00:00.000Z"
        },
        {
          "step": 4,
          "status": "delivered",
          "label": "Distribuée",
          "at": "2026-09-25T09:31:00.000Z"
        }
      ],
      "recipient": [
        "Service clients Exemple",
        "5 avenue de la Gare",
        "75010 Paris"
      ],
      "amountCents": 0,
      "reference": "CRM-4813",
      "test": true,
      "proofs": [
        {
          "kind": "filing",
          "label": "Preuve de dépôt"
        }
      ]
    }
  ],
  "nextCursor": "eyJ0IjoiMjAyNi0wOS0yNFQwODoxMjowMy4wMDBaIiwiaSI6IjhmMmMxZjBlIn0",
  "hasMore": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.