{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Connect API Documentation","link":"/","routeSlug":"/"},{"type":"link","fsPath":"authentication.md","metadata":{"type":"markdown"},"label":"Authentication","link":"/authentication","routeSlug":"/authentication"},{"type":"link","fsPath":"webhooks.md","metadata":{"type":"markdown"},"label":"Webhooks","link":"/webhooks","routeSlug":"/webhooks"},{"type":"link","fsPath":"payload-jobs.md","metadata":{"type":"markdown"},"label":"Payload Jobs (PDF + Word)","link":"/payload-jobs","routeSlug":"/payload-jobs"},{"type":"group","label":"API Reference","items":[{"type":"link","label":"EasyPost Connect Public API","link":"/public-api/openapi","routeSlug":"/public-api/openapi"},{"type":"group","label":"Jobs","link":"/public-api/openapi/jobs","routeSlug":"/public-api/openapi/jobs","items":[{"label":"Retrieve Job Based on ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/jobs/jobscontroller_findone","routeSlug":"/public-api/openapi/jobs/jobscontroller_findone","metadata":{"seo":{"title":"Retrieve Job Based on ID","description":"Retrieve Job based on ID"}},"httpPath":"/jobs/{id}"},{"label":"Retrieve Jobs Sorted by Ascending StartDate and Filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/jobs/jobscontroller_findall","routeSlug":"/public-api/openapi/jobs/jobscontroller_findall","metadata":{"seo":{"title":"Retrieve Jobs Sorted by Ascending StartDate and Filters","description":"Retrieve Jobs sorted by ascending startDate. By default, the response contains the 100 (maxItems property) first items. To retrieve the next items matching the request, use the query parameter 'after' with the ID of the last item"}},"httpPath":"/jobs"},{"label":"Create Job For A Single File Workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/jobs/jobscontroller_createsinglefilejob","routeSlug":"/public-api/openapi/jobs/jobscontroller_createsinglefilejob","metadata":{"seo":{"title":"Create Job For A Single File Workflow","description":"Create a Job for a workflow based on a unique file. It returns the Job unique identifier and the url where to upload the file to be processed. Note that the Job will be in AWAITING_FOR_FILE status for maximum 2 hours and will be deleted if no file is provided."}},"httpPath":"/jobs/single-file"},{"label":"Create Job For A Payload PDF Workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/jobs/jobscontroller_createpayloadpdfjob","routeSlug":"/public-api/openapi/jobs/jobscontroller_createpayloadpdfjob","metadata":{"seo":{"title":"Create Job For A Payload PDF Workflow","description":"Create a Job for a workflow based on a PDF payload. It stores the provided payload and returns the url where to upload the PDF file to be processed. Note that the Job will be in AWAITING_FOR_FILE status for maximum 2 hours and will be deleted if no file is provided."}},"httpPath":"/jobs/payload-pdf"},{"label":"Create Job For A Payload Word Workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/jobs/jobscontroller_createpayloadwordjob","routeSlug":"/public-api/openapi/jobs/jobscontroller_createpayloadwordjob","metadata":{"seo":{"title":"Create Job For A Payload Word Workflow","description":"Create a Job for a workflow based on a Word payload. It stores the provided payload (including template data) and returns the Job unique identifier."}},"httpPath":"/jobs/payload-word"}]},{"type":"group","label":"SendingEvents","link":"/public-api/openapi/sendingevents","routeSlug":"/public-api/openapi/sendingevents","items":[{"label":"Retrieve SendingEvent Based on ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/sendingevents/sendingeventscontroller_findone","routeSlug":"/public-api/openapi/sendingevents/sendingeventscontroller_findone","metadata":{"seo":{"title":"Retrieve SendingEvent Based on ID","description":"Retrieve SendingEvent based on ID"}},"httpPath":"/sending-events/{id}"},{"label":"Retrieve SendingEvents Sorted by Ascending Start Date and Filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/sendingevents/sendingeventscontroller_findsendingevents","routeSlug":"/public-api/openapi/sendingevents/sendingeventscontroller_findsendingevents","metadata":{"seo":{"title":"Retrieve SendingEvents Sorted by Ascending Start Date and Filters","description":"Retrieve SendingEvents sorted by ascending startDate. By default, the response contains the 100 (maxItems property) first items. To retrieve the next items matching the request, use the query parameter 'after' with the ID of the last item"}},"httpPath":"/sending-events"},{"label":"Re-send a Completed SendingEvent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/sendingevents/sendingeventscontroller_resend","routeSlug":"/public-api/openapi/sendingevents/sendingeventscontroller_resend","metadata":{"seo":{"title":"Re-send a Completed SendingEvent","description":"Creates a new Sending Event from an existing one in a final state (success or failure). All tasks are re-executed using the original document. Not allowed on Sending Events that are themselves a re-send."}},"httpPath":"/sending-events/{id}/resend"},{"label":"Pre-signed URL to Download SendingEvent Files (Documents, ePod, Submission Report).","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/sendingevents/sendingeventscontroller_retrievedownloadurl","routeSlug":"/public-api/openapi/sendingevents/sendingeventscontroller_retrievedownloadurl","metadata":{"seo":{"title":"Pre-signed URL to Download SendingEvent Files (Documents, ePod, Submission Report).","description":"Retrieve Sending Event files (documents, ePod, Submission report). The file download can be initiated with a GET request on the received URL."}},"httpPath":"/sending-events/{id}/files/{fileReference}/download-url"}]},{"type":"group","label":"Workflows","link":"/public-api/openapi/workflows","routeSlug":"/public-api/openapi/workflows","items":[{"label":"Retrieve Workflow Configuration Based on ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/workflows/workflowscontroller_findone","routeSlug":"/public-api/openapi/workflows/workflowscontroller_findone","metadata":{"seo":{"title":"Retrieve Workflow Configuration Based on ID","description":"Retrieve Workflow Configuration based on ID"}},"httpPath":"/workflows/{id}"},{"label":"Retrieve Workflow Configurations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/workflows/workflowscontroller_findworkflows","routeSlug":"/public-api/openapi/workflows/workflowscontroller_findworkflows","metadata":{"seo":{"title":"Retrieve Workflow Configurations","description":"Retrieve the Workflow Configurations. By default, the response contains the 100 (maxItems property) first items. To retrieve the next items matching the request, use the query parameter 'after' with the ID of the last item"}},"httpPath":"/workflows"}]},{"type":"group","label":"Peppol Incoming Documents","link":"/public-api/openapi/peppol-incoming-documents","routeSlug":"/public-api/openapi/peppol-incoming-documents","items":[{"label":"Retrieve Incoming Peppol Documents with Sorting and Filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/peppol-incoming-documents/peppolcontroller_retrieveincomingpeppoldocumentsforfilter","routeSlug":"/public-api/openapi/peppol-incoming-documents/peppolcontroller_retrieveincomingpeppoldocumentsforfilter","metadata":{"seo":{"title":"Retrieve Incoming Peppol Documents with Sorting and Filters","description":"Retrieve Incoming Peppol Documents. Use the 'sortField' parameter to choose the ordering field: 'createdAt' (default) or 'lastModifiedAt', and the 'sortOrder' parameter to choose the direction: 'desc' (default) or 'asc'. The 'from' and 'until' filters apply to the same field selected by 'sortField'. By default, the response contains the 100 (maxItems property) first items. To retrieve the next items matching the request, use the query parameter 'after' with the ID of the last item."}},"httpPath":"/peppol-incoming-documents"},{"label":"Retrieve Incoming Peppol Document Based on ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/peppol-incoming-documents/peppolcontroller_retrieveincomingpeppoldocument","routeSlug":"/public-api/openapi/peppol-incoming-documents/peppolcontroller_retrieveincomingpeppoldocument","metadata":{"seo":{"title":"Retrieve Incoming Peppol Document Based on ID","description":"Retrieve Incoming Peppol Document based on ID"}},"httpPath":"/peppol-incoming-documents/sender/{senderId}/document/{id}"},{"label":"Retrieve Incoming Peppol Document Pre-Signed Download URL Based on ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/peppol-incoming-documents/peppolcontroller_retrievedownloadurl","routeSlug":"/public-api/openapi/peppol-incoming-documents/peppolcontroller_retrievedownloadurl","metadata":{"seo":{"title":"Retrieve Incoming Peppol Document Pre-Signed Download URL Based on ID","description":"Retrieve a pre-signed URL for downloading the Incoming Peppol Document identified by the given ID. It is valid for 10 minutes"}},"httpPath":"/peppol-incoming-documents/sender/{senderId}/document/{id}/download-url"}]},{"type":"group","label":"Companies","link":"/public-api/openapi/companies","routeSlug":"/public-api/openapi/companies","items":[{"label":"Create a Company","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/companies/companiescontroller_createcompany","routeSlug":"/public-api/openapi/companies/companiescontroller_createcompany","metadata":{"seo":{"title":"Create a Company","description":"Create a Company based on the provided details."}},"httpPath":"/companies"},{"label":"Retrieve All Managed Companies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/companies/companiescontroller_findall","routeSlug":"/public-api/openapi/companies/companiescontroller_findall","metadata":{"seo":{"title":"Retrieve All Managed Companies","description":"Retrieve all managed companies."}},"httpPath":"/companies"},{"label":"Retrieve a Company Based on ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/companies/companiescontroller_findcompanybyid","routeSlug":"/public-api/openapi/companies/companiescontroller_findcompanybyid","metadata":{"seo":{"title":"Retrieve a Company Based on ID","description":"Retrieve a Company based on ID"}},"httpPath":"/companies/{id}"},{"label":"Update a Company Based on ID","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/companies/companiescontroller_updatecompany","routeSlug":"/public-api/openapi/companies/companiescontroller_updatecompany","metadata":{"seo":{"title":"Update a Company Based on ID","description":"Update a Company based on ID. It returns the updated Company."}},"httpPath":"/companies/{id}"}]},{"type":"group","label":"Departments","link":"/public-api/openapi/departments","routeSlug":"/public-api/openapi/departments","items":[{"label":"Create a Department","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/departments/departmentscontroller_createdepartment","routeSlug":"/public-api/openapi/departments/departmentscontroller_createdepartment","metadata":{"seo":{"title":"Create a Department","description":"Create a Department based on the provided details."}},"httpPath":"/departments"},{"label":"Retrieve All Managed Departments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/departments/departmentscontroller_findall","routeSlug":"/public-api/openapi/departments/departmentscontroller_findall","metadata":{"seo":{"title":"Retrieve All Managed Departments","description":"Retrieve all managed departments."}},"httpPath":"/departments"},{"label":"Update a Department Based on ID","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/departments/departmentscontroller_updatedepartment","routeSlug":"/public-api/openapi/departments/departmentscontroller_updatedepartment","metadata":{"seo":{"title":"Update a Department Based on ID","description":"Update a Department based on ID. It returns the updated Department."}},"httpPath":"/departments/{id}"},{"label":"Retrieve a Department Based on ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/departments/departmentscontroller_finddepartmentbyid","routeSlug":"/public-api/openapi/departments/departmentscontroller_finddepartmentbyid","metadata":{"seo":{"title":"Retrieve a Department Based on ID","description":"Retrieve a Department based on ID"}},"httpPath":"/departments/{id}"}]},{"type":"group","label":"Users","link":"/public-api/openapi/users","routeSlug":"/public-api/openapi/users","items":[{"label":"Create a User","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/users/userscontroller_createuser","routeSlug":"/public-api/openapi/users/userscontroller_createuser","metadata":{"seo":{"title":"Create a User","description":"Create a User based on the provided details."}},"httpPath":"/users"},{"label":"Retrieve All Managed Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/users/userscontroller_findall","routeSlug":"/public-api/openapi/users/userscontroller_findall","metadata":{"seo":{"title":"Retrieve All Managed Users","description":"Retrieve all managed users."}},"httpPath":"/users"},{"label":"Update a User Based on ID","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/users/userscontroller_updateuser","routeSlug":"/public-api/openapi/users/userscontroller_updateuser","metadata":{"seo":{"title":"Update a User Based on ID","description":"Update a User based on ID. It returns the updated User."}},"httpPath":"/users/{id}"},{"label":"Retrieve a User Based on ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/users/userscontroller_finduserbyid","routeSlug":"/public-api/openapi/users/userscontroller_finduserbyid","metadata":{"seo":{"title":"Retrieve a User Based on ID","description":"Retrieve a User based on ID"}},"httpPath":"/users/{id}"}]},{"type":"group","label":"Usage","link":"/public-api/openapi/usage","routeSlug":"/public-api/openapi/usage","items":[{"label":"Retrieve Usage Data for a Specific Company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/usage/usagecontroller_getusage","routeSlug":"/public-api/openapi/usage/usagecontroller_getusage","metadata":{"seo":{"title":"Retrieve Usage Data for a Specific Company","description":"Retrieve usage data for a specific company with filters."}},"httpPath":"/usage"},{"label":"Retrieve Detailed Usage Events for a Specific Company","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/usage/usagecontroller_getusagedetails","routeSlug":"/public-api/openapi/usage/usagecontroller_getusagedetails","metadata":{"seo":{"title":"Retrieve Detailed Usage Events for a Specific Company","description":"Retrieve detailed usage events for a specific company with filters."}},"httpPath":"/usage/details"}]},{"type":"group","label":"Webhook Subscriptions","link":"/public-api/openapi/webhook-subscriptions","routeSlug":"/public-api/openapi/webhook-subscriptions","items":[{"label":"Create a Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/webhook-subscriptions/webhookscontroller_createwebhooksubscription","routeSlug":"/public-api/openapi/webhook-subscriptions/webhookscontroller_createwebhooksubscription","metadata":{"seo":{"title":"Create a Webhook Subscription","description":"Create a webhook subscription for a given company."}},"httpPath":"/webhooks"},{"label":"Retrieve All Webhook Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/webhook-subscriptions/webhookscontroller_findwebhooksubscriptions","routeSlug":"/public-api/openapi/webhook-subscriptions/webhookscontroller_findwebhooksubscriptions","metadata":{"seo":{"title":"Retrieve All Webhook Subscriptions","description":"Retrieve all webhook subscriptions for a given company."}},"httpPath":"/webhooks"},{"label":"Retrieve a Webhook Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/webhook-subscriptions/webhookscontroller_findwebhookbyid","routeSlug":"/public-api/openapi/webhook-subscriptions/webhookscontroller_findwebhookbyid","metadata":{"seo":{"title":"Retrieve a Webhook Subscription","description":"Retrieve a webhook subscription by ID."}},"httpPath":"/webhooks/{id}"},{"label":"Update a Webhook Subscription","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/webhook-subscriptions/webhookscontroller_updatewebhook","routeSlug":"/public-api/openapi/webhook-subscriptions/webhookscontroller_updatewebhook","metadata":{"seo":{"title":"Update a Webhook Subscription","description":"Update a webhook subscription by ID."}},"httpPath":"/webhooks/{id}"},{"label":"Delete a Webhook Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/webhook-subscriptions/webhookscontroller_deletewebhook","routeSlug":"/public-api/openapi/webhook-subscriptions/webhookscontroller_deletewebhook","metadata":{"seo":{"title":"Delete a Webhook Subscription","description":"Delete a webhook subscription by ID."}},"httpPath":"/webhooks/{id}"},{"label":"Reset a Webhook Secret","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/webhook-subscriptions/webhookscontroller_resetwebhooksecret","routeSlug":"/public-api/openapi/webhook-subscriptions/webhookscontroller_resetwebhooksecret","metadata":{"seo":{"title":"Reset a Webhook Secret","description":"Reset the secret for a webhook subscription by ID and return the new secret once."}},"httpPath":"/webhooks/{id}/reset-secret"},{"label":"Test a Webhook Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/public-api/openapi/webhook-subscriptions/webhookscontroller_testwebhook","routeSlug":"/public-api/openapi/webhook-subscriptions/webhookscontroller_testwebhook","metadata":{"seo":{"title":"Test a Webhook Subscription","description":"Sends a test event matching one of the subscribed event types to the subscription URL and returns the HTTP response status. When the subscription has more than one event type, eventType must be provided."}},"httpPath":"/webhooks/{id}/test"}]},{"type":"group","label":"Webhook Events","link":"/public-api/openapi/webhook-events","routeSlug":"/public-api/openapi/webhook-events","items":[{"label":"Job Status Changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/public-api/openapi/webhook-events/jobstatuschangedwebhook","routeSlug":"/public-api/openapi/webhook-events/jobstatuschangedwebhook","metadata":{"seo":{"title":"Job Status Changed","description":"Sent when a job status changes."}},"httpPath":"job.status.changed"},{"label":"Sending Event Status Changed","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/public-api/openapi/webhook-events/sendingeventstatuschangedwebhook","routeSlug":"/public-api/openapi/webhook-events/sendingeventstatuschangedwebhook","metadata":{"seo":{"title":"Sending Event Status Changed","description":"Sent when a sending event business status changes."}},"httpPath":"sending.event.status.changed"},{"label":"Sending Event File Ready","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/public-api/openapi/webhook-events/sendingeventfilereadywebhook","routeSlug":"/public-api/openapi/webhook-events/sendingeventfilereadywebhook","metadata":{"seo":{"title":"Sending Event File Ready","description":"Sent when a generated sending event file is ready for download."}},"httpPath":"sending.event.file.ready"},{"label":"Peppol Document Received","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/public-api/openapi/webhook-events/peppoldocumentreceivedwebhook","routeSlug":"/public-api/openapi/webhook-events/peppoldocumentreceivedwebhook","metadata":{"seo":{"title":"Peppol Document Received","description":"Sent when an incoming Peppol document is received."}},"httpPath":"peppol.document.received"}]}]}]}