Skip to content

API reference

  • OpenAPI 3.1
  • Version 2026-11-01
  • 42 operations
  • curl · TypeScript · Python
Try it

Code examples

Every example runs against the sandbox in the SDKs' CI.
curl -X POST https://api.bodo-app.com/v1/contacts \
  -H "Authorization: Bearer $BODO_API_KEY" \
  -H "Bodo-Preview: true" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"Erika","lastName":"Mustermann","email":"erika@musterfirma.de"}'
Loading the reference

All operations

Preview operations need Bodo-Preview: true, otherwise the API answers 404 OPERATION_NOT_IN_VERSION. Preview is no basis for production. Operation names are in German, as in the spec.
MethodPathOperationChannelScopeCost
GET/v1/meWho am I?Stable—1 point
GET/v1/rate_limitLimit statusStable—1 point
GET/v1/openapi.jsonThe OpenAPI specStable—1 point
GET/v1/contactsList contactsStablecontacts:read2 points
POST/v1/contactsCreate a contactPreviewcontacts:write5 points
GET/v1/contacts/countCount contactsStablecontacts:read2 points
GET/v1/contacts/{id}Read a contactStablecontacts:read1 point
PATCH/v1/contacts/{id}Update a contactPreviewcontacts:write5 points
DELETE/v1/contacts/{id}Delete a contactPreviewcontacts:write10 points
GET/v1/companiesList companiesStablecompanies:read2 points
POST/v1/companiesCreate a companyPreviewcompanies:write5 points
GET/v1/companies/countCount companiesStablecompanies:read2 points
GET/v1/companies/{id}Read a companyStablecompanies:read1 point
PATCH/v1/companies/{id}Update a companyPreviewcompanies:write5 points
DELETE/v1/companies/{id}Delete a companyPreviewcompanies:write10 points
GET/v1/tasksList tasksStabletasks:read2 points
POST/v1/tasksCreate a taskPreviewtasks:write5 points
GET/v1/tasks/countCount tasksStabletasks:read2 points
GET/v1/tasks/{id}Read a taskStabletasks:read1 point
PATCH/v1/tasks/{id}Update a taskPreviewtasks:write5 points
DELETE/v1/tasks/{id}Delete a taskPreviewtasks:write10 points
POST/v1/tasks/{id}/completeComplete a taskPreviewtasks:write5 points
GET/v1/documentsList documentsStabledocuments:read2 points
POST/v1/documentsCreate a document from an uploadPreviewdocuments:write10 points
GET/v1/documents/countCount documentsStabledocuments:read2 points
GET/v1/documents/{id}Read a documentStabledocuments:read1 point
PATCH/v1/documents/{id}Update a documentPreviewdocuments:write5 points
DELETE/v1/documents/{id}Delete a documentPreviewdocuments:write10 points
GET/v1/documents/{id}/contentDownload the fileStabledocuments:read1 point
POST/v1/uploadsCreate an upload sessionPreviewdocuments:write5 points
POST/v1/batchBundle several callsPreview—0 points
GET/v1/operations/{id}Poll an operationStable—1 point
GET/v1/webhook_endpointsList webhook endpointsStablewebhook_endpoints:read2 points
POST/v1/webhook_endpointsCreate a webhook endpointPreviewwebhook_endpoints:write5 points
GET/v1/webhook_endpoints/{id}Read a webhook endpointStablewebhook_endpoints:read1 point
PATCH/v1/webhook_endpoints/{id}Update a webhook endpointPreviewwebhook_endpoints:write5 points
DELETE/v1/webhook_endpoints/{id}Delete a webhook endpointPreviewwebhook_endpoints:write10 points
POST/v1/webhook_endpoints/{id}/testSend a test eventPreviewwebhook_endpoints:write5 points
POST/v1/webhook_endpoints/{id}/rotate_secretRotate the signing secretPreviewwebhook_endpoints:write5 points
GET/v1/webhook_endpoints/{id}/deliveriesRead the delivery logStablewebhook_endpoints:read2 points
GET/v1/eventsList eventsStable—1 point
GET/v1/events/{id}Read an eventStable—1 point

Spec and Try it