API reference

Mailbox messages

The emails a mailbox search read, and whether each became a charge's receipt.

List the messages mailbox searches opened

GET/v1/mailbox_messages

client.mailboxMessages.list()

The messages mailbox searches opened, newest first, with what became of each: kept as a receipt, or set aside.

Name	Type	Description
`connection_id`Query	string or null	An id that starts with `conn_`.
`status`Query	MessageStatus or null	Only messages kept, or only those set aside.
`limit`Query	integer	Page size, 1–200. Default 50
`cursor`Query	string or null	The `next_cursor` of the previous page.

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

curl

curl "https://api.ledgerit.ai/v1/mailbox_messages" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

GET/v1/mailbox_messages/{message_id}

client.mailboxMessages.get()

One message a mailbox search opened, and what became of it.

Name	Type	Description
`message_id`Path · Required	string	An id that starts with `mail_msg_`.

400: The request was malformed or a parameter is invalid.
401: No valid credential was sent.
403: The credential or the member's role does not allow this.
404: No such resource in this ledger.
409: A conflicting request, e.g. one with the same Idempotency-Key still running.
422: A well-formed request a business rule refused.
429: Too many requests; retry after the Retry-After header.
500: Something failed on our side; the request_id identifies it.

curl

curl "https://api.ledgerit.ai/v1/mailbox_messages/{message_id}" \
  -H "Authorization: Bearer $LEDGERIT_TOKEN"

The objects these operations take and return.

A page of the messages mailbox searches opened, newest first.

One message a mailbox search opened, and what became of it.

Name	Type	Description
`connection_id`Required	string	The mailbox it is in.
`document_id`Required	string or null	An id that starts with `doc_`.
`id`Required	string	An id that starts with `mail_msg_`.
`opened_at`Required	string (date-time)	When the search opened it.
`received_at`Required	string (date-time)	When it arrived in the mailbox.
`sender`Required	string or null	Who sent it.
`status`Required	string	`kept`: it is a receipt, and `document_id` is the document it became. `not_a_receipt`: read and set aside; nothing of its body is kept.
`subject`Required	string or null
`transaction_id`Required	string or null	An id that starts with `txn_`.