Factuarea APIDevelopers

Llista els emails enviats

Consulta els emails que la teva empresa ha enviat per la plataforma — factures, pressupostos, factures proforma, albarans, recordatoris de cobrament —, de més recent a més antic, per poder respondre a «ha sortit de debò l'email d'aquesta factura?» sense preguntar-ho al teu client.

  • Acotat a l'empresa autenticada.

  • IMPORTANT — status descriu el lliurament al SERVIDOR SMTP DE SORTIDA, no el lliurament real: sent significa que el servidor de correu de sortida ha acceptat el missatge, no que el destinatari l'hagi rebut.

GET
/emails
AuthorizationBearer <token>

A: header

Paràmetres de consulta

status?string

Estat de lliurament pel qual filtrar (queued, sending, sent, failed). Reflecteix el lliurament al servidor SMTP de sortida, no el lliurament real a la safata.

Valor a"queued" | "sending" | "sent" | "failed"
recipient_email?string

Adreça exacta del destinatari per la qual filtrar. Per a coincidències parcials fes servir search.

Longitudlength <= 255
related_entity_id?string

UUID v7 del document relacionat. S'admet sense related_entity_type.

Formatuuid
related_entity_type?string

Tipus de document opcional que acota la resolució de related_entity_id.

Valor a"invoice" | "quote" | "proforma" | "delivery_note" | "purchase_invoice" | "recurring_invoice"
created_at[gte]?string

Límit inferior inclusiu de created_at (ISO 8601).

Formatdate-time
created_at[lte]?string

Límit superior inclusiu de created_at (ISO 8601).

Formatdate-time
search?string

Coincidència parcial, sense distingir majúscules, contra l'assumpte i el destinatari.

Longitudlength <= 255
limit?integer

Nombre d'emails a retornar. Enter entre 1 i 100. Per defecte 25. Un valor no enter o fora de rang retorna 400.

Predeterminat25
Rang1 <= value <= 100
starting_after?string

Cursor de paginació cap endavant: torna a enviar el next_cursor de la pàgina anterior. Tracta'l com a opac — a diferència de la resta de llistats de v1 és una cadena numèrica, no un UUID v7. Un cursor mal format retorna 400.

Coincidència^[0-9]+$

Headers

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate
X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json