Reference
API reference
Every endpoint of the Macaaw Public API 1.0.0, generated from the OpenAPI 3.1 document. Base URL https://macaaw.com/public/v1.
All requests need Authorization: API-Key <key> (see Authentication). Errors share one format (see Errors):
JSON
{
"type": "request_error",
"code": "VALIDATION",
"detail": "Please check what you entered. (invalid_fields)",
"info": { "reason": "invalid_fields", "fields": [{ "path": "recipients", "code": "too_small" }] }
}Documents#
- GET/documentsList documents
- POST/documentsCreate a document from a PDF
- GET/documents/{id}Document status
- DELETE/documents/{id}Delete a document now (files and records)
- GET/documents/{id}/detailsDocument details
- POST/documents/{id}/sendSend a draft for signature
- POST/documents/{id}/remindRemind signers
- PATCH/documents/{id}/statusVoid a sent document
- GET/documents/{id}/downloadDownload the PDF
- POST/documents/{id}/sessionEmbedded signing session
Tasks#
Invoice checks#
Webhooks#
- GET/webhook-subscriptionsList webhook subscriptions
- POST/webhook-subscriptionsCreate a webhook subscription
- GET/webhook-subscriptions/{uuid}Get a webhook subscription
- PATCH/webhook-subscriptions/{uuid}Update a webhook subscription
- DELETE/webhook-subscriptions/{uuid}Delete a webhook subscription
- POST/webhook-subscriptions/{uuid}/shared-keyRegenerate the shared key
- GET/webhook-eventsDelivery history
- POST/webhook-events/{id}/resendResend a delivery now