New to Corsair? See API access, authentication, and error handling.
Data
getParsed
data.getParsed
Read the parsed data records of a mailbox, paged by date
Risk: read
Paged parsed data for the mailbox documents.
Output
docs full type
docs full type
listEmails
data.listEmails
List the email addresses the mailbox collected
Risk: read
Email addresses the mailbox collected automatically.
Output:
object[]
Output full type
Output full type
Documents
createAsync
documents.createAsync
Parse HTML or text content asynchronously; poll documents.get for the result
Risk: destructive
Returns parsing_in_progress true with status parsing; the job wrapper follows it with documents.get until status is parsed.
Output
createSync
documents.createSync
Parse HTML or text content and wait for the result; template and GPT parsers only, each parse consumes credits
Risk: destructive
Supported only by the template-based and GPT-powered parsers; when parsing_in_progress is true, poll documents.get.
Output
get
documents.get
Read one parsed document; this is the payload Parsio webhooks deliver
Risk: read
Output
list
documents.list
List the documents of a mailbox, filtered by date, name or status
Risk: read
per_page is capped at 500; status filters by document status.
Output
docs full type
docs full type
reparse
documents.reparse
Queue a document for reprocessing; each reparse consumes credits
Risk: destructive
Queues the document for reprocessing and consumes credits again.
Output
skipMany
documents.skipMany
Skip parsing for the given documents
Risk: write
Answers 204 with no body.
Output
uploadAsync
documents.uploadAsync
Upload one file (max 50MB, ZIP supported) and parse it asynchronously
Risk: destructive
One file per request, ZIP supported, max 50MB.
Output
uploadSync
documents.uploadSync
Upload one file (max 20MB, no ZIP) and wait for the parsed result
Risk: destructive
One file per request, no ZIP, max 20MB; works with all parser types whose mailbox supports the file type.
Output
Mailboxes
create
mailboxes.create
Create a mailbox with a parser preset
Risk: write
preset picks the parser type; ml_model picks the OCR or AI model the mailbox uses.
Output
delete
mailboxes.delete
Delete a mailbox
Risk: destructive · Irreversible
Answers 204 with no body.
Output
get
mailboxes.get
Read one mailbox with its settings and configuration
Risk: read
Output
list
mailboxes.list
List all mailboxes available to the authenticated user
Risk: read
object[]
Output full type
Output full type
tableFields
mailboxes.tableFields
List the table fields configured in a mailbox
Risk: read
Output:
object[]
Output full type
Output full type
update
mailboxes.update
Update mailbox settings: name, email prefix, attachments, alerts
Risk: write
Output
Webhooks
create
webhooks.create
Create a webhook subscription for doc.parsed, doc.fail, doc.received or table.parsed events
Risk: write
Events: doc.parsed, doc.parsed.flat, doc.fail, doc.received, table.parsed. table_id is required only for table.parsed. The answer includes the webhook signing secret: store it with keys.set_webhook_signature. table_id is sent empty when unset (the API refuses it missing).
Output
delete
webhooks.delete
Delete webhook subscriptions; deliveries stop until they are created again
Risk: destructive · Irreversible
Answers 204 with no body.
Output
get
webhooks.get
Read one webhook subscription
Risk: read
Output
listForMailbox
webhooks.listForMailbox
List the webhook subscriptions of a mailbox
Risk: read
Output:
object[]
Output full type
Output full type
update
webhooks.update
Update a webhook subscription
Risk: write
Takes the webhook id as _id in the body.
Output