Parseur

App · 18 actions

Turn emails, PDFs and scans into structured data with Parseur: send documents to a mailbox, read what was extracted, and manage mailboxes and webhooks.

Actions

ActionWhat it does
Connect webhook to mailboxMake a mailbox send its events to a webhook.
Create mailboxCreate a mailbox to receive documents.
Create webhookHave Parseur send an event (such as a parsed document) to an https address.
Delete documentDelete a document and its extracted data.
Delete mailboxDelete a mailbox and every document and template in it.
Delete webhookDelete a webhook so Parseur stops sending to it.
Disconnect webhook from mailboxStop a mailbox sending events to a webhook, keeping the webhook itself.
Get account and usageGet the connected Parseur account: its plan and how many documents it has processed this billing period.
Get documentGet one document with its status, the data Parseur extracted from it (result) and the text it read.
Get mailboxGet one mailbox with its document counts, template count and settings.
List documentsList the documents in a mailbox, newest first, with their status and extracted data.
List mailboxesList the account's mailboxes, optionally matching a name.
List webhooksList the account's webhooks with their events and addresses.
Rename mailboxChange a mailbox's name.
Reprocess documentHave Parseur read a document again, for example after the mailbox's templates changed.
Skip documentMark a document as skipped so Parseur does not parse it or use credits on it.
Upload documentAdd a file (PDF, image, spreadsheet, email, Word and more) to a mailbox for Parseur to read, and wait for the extracted data.
Upload textAdd text (an email body, a message, copied content) to a mailbox as a document, and wait for the extracted data.

Connect webhook to mailbox

Make a mailbox send its events to a webhook.

Inputs

Mailboxparser_idtextRequired
The Parseur mailbox. Pick one, or give its id from an earlier step.
Webhookwebhook_idtextRequired
The webhook. Pick one, or give its id from an earlier step.

Outputs

connectedtrue/false
True once connected
parser_idtext
The mailbox
webhook_idtext
The webhook
Example output
{
  "connected": true,
  "parser_id": "223873",
  "webhook_id": "256704"
}

Create mailbox

Create a mailbox to receive documents. Set up what it extracts in Parseur afterwards.

Inputs

NamenametextRequired
The mailbox's name.

Outputs

parserobject
The mailbox
Example output
{
  "parser": {
    "ai_engine": "GCP_AI_4",
    "allowed_extensions": [
      "pdf",
      "png",
      "txt"
    ],
    "document_count": 12,
    "email_prefix": "supplier.invoices",
    "failed_count": 1,
    "last_activity": "2026-11-12 06:51:32+00:00",
    "name": "Supplier invoices",
    "parsed_count": 10,
    "parser_id": "223873",
    "retention_days": 90,
    "template_count": 1,
    "webhook_count": 0
  }
}

Create webhook

Have Parseur send an event (such as a parsed document) to an https address. Choose a mailbox to connect it to at once.

Inputs

NamenametextRequired
A name to recognise the webhook by.
EventeventtextRequired
When Parseur should send it.One of: document.processed (Document parsed), document.processed.flattened (Document parsed (one flat record)), document.template_needed (Document needs a template), document.export_failed (Document export failed), table.processed (Table parsed), table.processed.flattened (Table parsed (one row per record)).
Addresstarget_urltextRequired
The https:// address to send the event to.
Mailboxparser_idtext
Connect the webhook to this mailbox. Leave empty to connect it later.

Outputs

parser_idtext
The mailbox it was connected to, empty if none
webhookobject
The webhook
Example output
{
  "parser_id": "223873",
  "webhook": {
    "category": "CUSTOM",
    "event": "document.processed",
    "name": "Send parsed documents to Lodol",
    "target_url": "https://example.com/hooks/parseur",
    "webhook_id": "256704"
  }
}

Delete document

Delete a document and its extracted data. This cannot be undone.

Inputs

Document IDdocument_idtextRequired
The document's id, from 'List documents', 'Upload document' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
document_idtext
The document deleted
Example output
{
  "deleted": true,
  "document_id": "fcd5d3f2171046f1a22c8fc86db157c7"
}

Delete mailbox

Delete a mailbox and every document and template in it. This cannot be undone.

Inputs

Mailboxparser_idtextRequired
The Parseur mailbox. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
parser_idtext
The mailbox deleted
Example output
{
  "deleted": true,
  "parser_id": "223873"
}

Delete webhook

Delete a webhook so Parseur stops sending to it.

Inputs

Webhookwebhook_idtextRequired
The webhook. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
webhook_idtext
The webhook deleted
Example output
{
  "deleted": true,
  "webhook_id": "256704"
}

Disconnect webhook from mailbox

Stop a mailbox sending events to a webhook, keeping the webhook itself.

Inputs

Mailboxparser_idtextRequired
The Parseur mailbox. Pick one, or give its id from an earlier step.
Webhookwebhook_idtextRequired
The webhook. Pick one, or give its id from an earlier step.

Outputs

connectedtrue/false
False once disconnected
parser_idtext
The mailbox
webhook_idtext
The webhook
Example output
{
  "connected": false,
  "parser_id": "223873",
  "webhook_id": "256704"
}

Get account and usage

Get the connected Parseur account: its plan and how many documents it has processed this billing period.

Inputs

None.

Outputs

account_idtext
The account's id
account_nametext
The account's name
documents_allowednumber
Documents the plan allows each period
documents_usednumber
Documents processed this period
emailtext
The signed-in user's email
period_endstext
When the billing period ends
plantext
The plan, such as Free
Example output
{
  "account_id": "acc_fe69ed90223b4fbb818ab33e0b07c2e8",
  "account_name": "Acme",
  "documents_allowed": 20,
  "documents_used": 1,
  "email": "me@example.com",
  "period_ends": "2026-12-12T06:51:05Z",
  "plan": "Free"
}

Get document

Get one document with its status, the data Parseur extracted from it (result) and the text it read.

Inputs

Document IDdocument_idtextRequired
The document's id, from 'List documents', 'Upload document' or an earlier step.

Outputs

documentobject
The document
Example output
{
  "document": {
    "content": "Invoice 123 Total: 45.60 USD",
    "credits_used": 1,
    "csv_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.csv",
    "document_id": "fcd5d3f2171046f1a22c8fc86db157c7",
    "excel_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.xlsx",
    "finished": true,
    "json_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.json",
    "name": "invoice-123.pdf",
    "number": 145683526,
    "original_url": "https://api.parseur.com/document/abc/invoice-123.pdf",
    "parser_id": "223873",
    "processed": "2026-11-12T07:04:56Z",
    "received": "2026-11-12T07:04:49Z",
    "result": {
      "currency": "USD",
      "invoice_number": "123",
      "total_amount": 45.6
    },
    "status": "PARSEDOK",
    "template_id": 4821
  }
}

Get mailbox

Get one mailbox with its document counts, template count and settings.

Inputs

Mailboxparser_idtextRequired
The Parseur mailbox. Pick one, or give its id from an earlier step.

Outputs

parserobject
The mailbox
Example output
{
  "parser": {
    "ai_engine": "GCP_AI_4",
    "allowed_extensions": [
      "pdf",
      "png",
      "txt"
    ],
    "document_count": 12,
    "email_prefix": "supplier.invoices",
    "failed_count": 1,
    "last_activity": "2026-11-12 06:51:32+00:00",
    "name": "Supplier invoices",
    "parsed_count": 10,
    "parser_id": "223873",
    "retention_days": 90,
    "template_count": 1,
    "webhook_count": 0
  }
}

List documents

List the documents in a mailbox, newest first, with their status and extracted data.

Inputs

Mailboxparser_idtextRequired
The Parseur mailbox. Pick one, or give its id from an earlier step.
Name containssearchtext
Only documents matching this text.
Statusstatustext
Only documents in this state. Leave empty for all.One of: PARSEDOK (Parsed), PARSEDKO (Could not be parsed), INCOMING (Waiting to be processed), ANALYZING (Being analyzed), PROGRESS (In progress), QUOTAEXC (Over the plan's quota), SKIPPED, SPLIT (Split into other documents), EXPORTKO (Export failed), TRANSKO (Transformation failed), INVALID.
Received on or afterreceived_afterdate
Only documents received on or after this date.
Received on or beforereceived_beforedate
Only documents received on or before this date.
Orderordertext
Sort by when the document was received.One of: newest (Newest first (default)), oldest (Oldest first).
Pagepagenumber
Which page of results to return, starting at 1.At least 1.
Page sizepage_sizenumber
How many to return on a page, 1 to 100. The default is 25.From 1 to 100.

Outputs

countnumber
How many there are in all
documentslist
The documents
has_moretrue/false
Whether a later page exists; ask for page + 1
pagenumber
The page returned
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "documents": [
    {
      "content": "Invoice 123 Total: 45.60 USD",
      "credits_used": 1,
      "csv_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.csv",
      "document_id": "fcd5d3f2171046f1a22c8fc86db157c7",
      "excel_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.xlsx",
      "finished": true,
      "json_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.json",
      "name": "invoice-123.pdf",
      "number": 145683526,
      "original_url": "https://api.parseur.com/document/abc/invoice-123.pdf",
      "parser_id": "223873",
      "processed": "2026-11-12T07:04:56Z",
      "received": "2026-11-12T07:04:49Z",
      "result": {
        "currency": "USD",
        "invoice_number": "123",
        "total_amount": 45.6
      },
      "status": "PARSEDOK",
      "template_id": 4821
    }
  ],
  "has_more": false,
  "page": 1,
  "total_pages": 1
}

List mailboxes

List the account's mailboxes, optionally matching a name.

Inputs

Name containssearchtext
Only mailboxes whose name contains this text.
Pagepagenumber
Which page of results to return, starting at 1.At least 1.
Page sizepage_sizenumber
How many to return on a page, 1 to 100. The default is 25.From 1 to 100.

Outputs

countnumber
How many there are in all
has_moretrue/false
Whether a later page exists; ask for page + 1
pagenumber
The page returned
parserslist
The mailboxes
total_pagesnumber
How many pages there are
Example output
{
  "count": 1,
  "has_more": false,
  "page": 1,
  "parsers": [
    {
      "ai_engine": "GCP_AI_4",
      "allowed_extensions": [
        "pdf",
        "png",
        "txt"
      ],
      "document_count": 12,
      "email_prefix": "supplier.invoices",
      "failed_count": 1,
      "last_activity": "2026-11-12 06:51:32+00:00",
      "name": "Supplier invoices",
      "parsed_count": 10,
      "parser_id": "223873",
      "retention_days": 90,
      "template_count": 1,
      "webhook_count": 0
    }
  ],
  "total_pages": 1
}

List webhooks

List the account's webhooks with their events and addresses.

Inputs

None.

Outputs

countnumber
How many
webhookslist
The webhooks
Example output
{
  "count": 1,
  "webhooks": [
    {
      "category": "CUSTOM",
      "event": "document.processed",
      "name": "Send parsed documents to Lodol",
      "target_url": "https://example.com/hooks/parseur",
      "webhook_id": "256704"
    }
  ]
}

Rename mailbox

Change a mailbox's name.

Inputs

Mailboxparser_idtextRequired
The Parseur mailbox. Pick one, or give its id from an earlier step.
New namenametextRequired
The mailbox's new name.

Outputs

parserobject
The mailbox
Example output
{
  "parser": {
    "ai_engine": "GCP_AI_4",
    "allowed_extensions": [
      "pdf",
      "png",
      "txt"
    ],
    "document_count": 12,
    "email_prefix": "supplier.invoices",
    "failed_count": 1,
    "last_activity": "2026-11-12 06:51:32+00:00",
    "name": "Supplier invoices",
    "parsed_count": 10,
    "parser_id": "223873",
    "retention_days": 90,
    "template_count": 1,
    "webhook_count": 0
  }
}

Reprocess document

Have Parseur read a document again, for example after the mailbox's templates changed. Use 'Get document' for the outcome.

Inputs

Document IDdocument_idtextRequired
The document's id, from 'List documents', 'Upload document' or an earlier step.

Outputs

document_idtext
The document
queuedtrue/false
Always true once Parseur has queued it
Example output
{
  "document_id": "fcd5d3f2171046f1a22c8fc86db157c7",
  "queued": true
}

Skip document

Mark a document as skipped so Parseur does not parse it or use credits on it.

Inputs

Document IDdocument_idtextRequired
The document's id, from 'List documents', 'Upload document' or an earlier step.

Outputs

documentobject
The document
Example output
{
  "document": {
    "content": "Invoice 123 Total: 45.60 USD",
    "credits_used": 1,
    "csv_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.csv",
    "document_id": "fcd5d3f2171046f1a22c8fc86db157c7",
    "excel_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.xlsx",
    "finished": true,
    "json_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.json",
    "name": "invoice-123.pdf",
    "number": 145683526,
    "original_url": "https://api.parseur.com/document/abc/invoice-123.pdf",
    "parser_id": "223873",
    "processed": "2026-11-12T07:04:56Z",
    "received": "2026-11-12T07:04:49Z",
    "result": {
      "currency": "USD",
      "invoice_number": "123",
      "total_amount": 45.6
    },
    "status": "SKIPPED",
    "template_id": 4821
  }
}

Upload document

Add a file (PDF, image, spreadsheet, email, Word and more) to a mailbox for Parseur to read, and wait for the extracted data. Reading a document uses Parseur credits.

Inputs

Mailboxparser_idtextRequired
The Parseur mailbox. Pick one, or give its id from an earlier step.
FilefiletextRequired
The file: upload one here, pick a file from an earlier step, or give a public link to one.
Wait for the result (seconds)wait_secondsnumber
Parseur reads the document after the upload. Wait up to this many seconds (0 to 120) for it to finish and return the extracted data. Defaults to 20; 0 returns at once.From 0 to 120.

Outputs

documentobject
The document as Parseur held it when the step ended; check 'finished'
document_idtext
The new document's id
parser_idtext
The mailbox it was added to
Example output
{
  "document": {
    "content": "Invoice 123 Total: 45.60 USD",
    "credits_used": 1,
    "csv_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.csv",
    "document_id": "fcd5d3f2171046f1a22c8fc86db157c7",
    "excel_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.xlsx",
    "finished": true,
    "json_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.json",
    "name": "invoice-123.pdf",
    "number": 145683526,
    "original_url": "https://api.parseur.com/document/abc/invoice-123.pdf",
    "parser_id": "223873",
    "processed": "2026-11-12T07:04:56Z",
    "received": "2026-11-12T07:04:49Z",
    "result": {
      "currency": "USD",
      "invoice_number": "123",
      "total_amount": 45.6
    },
    "status": "PARSEDOK",
    "template_id": 4821
  },
  "document_id": "fcd5d3f2171046f1a22c8fc86db157c7",
  "parser_id": "223873"
}

Upload text

Add text (an email body, a message, copied content) to a mailbox as a document, and wait for the extracted data. Reading a document uses Parseur credits.

Inputs

Mailboxparser_idtextRequired
The Parseur mailbox. Pick one, or give its id from an earlier step.
TexttexttextRequired
The text for Parseur to read.
Document namefile_nametext
What to call the document. Defaults to document.txt.
Wait for the result (seconds)wait_secondsnumber
Parseur reads the document after the upload. Wait up to this many seconds (0 to 120) for it to finish and return the extracted data. Defaults to 20; 0 returns at once.From 0 to 120.

Outputs

documentobject
The document as Parseur held it when the step ended; check 'finished'
document_idtext
The new document's id
parser_idtext
The mailbox it was added to
Example output
{
  "document": {
    "content": "Invoice 123 Total: 45.60 USD",
    "credits_used": 1,
    "csv_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.csv",
    "document_id": "fcd5d3f2171046f1a22c8fc86db157c7",
    "excel_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.xlsx",
    "finished": true,
    "json_url": "https://api.parseur.com/document/abc/result/invoice-123.pdf.json",
    "name": "invoice-123.pdf",
    "number": 145683526,
    "original_url": "https://api.parseur.com/document/abc/invoice-123.pdf",
    "parser_id": "223873",
    "processed": "2026-11-12T07:04:56Z",
    "received": "2026-11-12T07:04:49Z",
    "result": {
      "currency": "USD",
      "invoice_number": "123",
      "total_amount": 45.6
    },
    "status": "PARSEDOK",
    "template_id": 4821
  },
  "document_id": "fcd5d3f2171046f1a22c8fc86db157c7",
  "parser_id": "223873"
}

On this page