Entwickler · REST-API

Aufbauen auf
Mewayz.

Eine REST-API für Ihren gesamten Workspace — CRM, Vertrieb, Rechnungsstellung, Buchhaltung, Projekte, Kasse, HR und mehr. 372 Endpunkte, überall JSON, authentifiziert mit einem Bearer-Token. Dieselbe durchsuchbare Referenz liegt in der App unter Einstellungen → API-Docs.

Basis-URL · app.mewayz.com/api Auth · Bearer-Token Format · JSON Endpunkte · 372

Authentifizierung

Jede Anfrage wird mit einem Bearer-Token authentifiziert. Generieren Sie eines in Ihrem Dashboard unter Einstellungen → API-Schlüssel — er wird nur einmal angezeigt, kopieren Sie ihn also dann. Ein Token erbt die Rollen & Berechtigungen des Benutzers, der ihn erstellt hat, und die meisten Ressourcen-Endpunkte erfordern außerdem, dass das passende Modul in Ihrem Tarif aktiviert ist.

Authorization-Header
# Übergeben Sie Ihr Token bei jeder Anfrage curl https://app.mewayz.com/api/leads \ -H "Authorization: Bearer 12|aZ8f3a...d92c" \ -H "Accept: application/json"

Lieber programmatisch authentifizieren? POST /api/login mit Ihrer E-Mail und Ihrem Passwort gibt ein Bearer-Token zurück, das Sie auf die gleiche Weise verwenden können, und POST /api/refresh rotiert ihn.

Schnellstart

Erstellen Sie einen CRM-Lead in unter einer Minute. Die API arbeitet mit denselben Daten, die Sie im Produkt sehen – es gibt keine separate Synchronisierungsschicht.

POST /api/lead/create
curl -X POST https://app.mewayz.com/api/lead/create \ -H "Authorization: Bearer 12|aZ8f3a..." \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "name": "Ada Lovelace", "email": "[email protected]" }'

Fehler & Statuscodes

Wir verwenden konventionelle HTTP-Statuscodes. Fehler-Bodies enthalten eine menschenlesbare Nachricht können Sie direkt anzeigen.

200OK — Anfrage erfolgreich
201Erstellt — Ressource erstellt
401Nicht autorisiert — fehlender oder ungültiger Token
422Nicht verarbeitbar — Validierung fehlgeschlagen
429Zu viele Anfragen – Sie haben ein Ratenlimit erreicht
500Serverfehler – wir haben es gleich Status

Ratenbegrenzungen

Der API-Verkehr ist ratenbegrenzt, damit die Plattform für alle schnell bleibt. Wenn Sie das Limit überschreiten, erhalten Sie eine HTTP 429 Antwort – zurückfahren und erneut versuchen. Die Retry-After Header sagt Ihnen, wann Sie fortfahren können.

Authentifizierung & Sitzung /api/login

Anmelden, Token aktualisieren oder widerrufen, den angemeldeten Nutzer abrufen, das Profil bearbeiten und Nutzerlisten für Mitarbeitende / Kunden / Lieferanten lesen. (11 Endpunkte)

POST/api/change-password
GET/api/client-user
LÖSCHEN/api/delete-account
POST/api/edit-profile
POST/api/login
POST/api/logout
POST/api/refresh
GET/api/staff-user
POST/api/upload-photos
GET/api/user
GET/api/vendor-user

API-Schlüssel /api/v1/settings/api-keys

Listen, erstellen und widerrufen Sie Ihre persönlichen Zugriffstoken – dieselben Schlüssel, die Sie unter Einstellungen → API-Schlüssel generieren. (3 Endpunkte)

GET/api/v1/settings/api-keys
POST/api/v1/settings/api-keys
LÖSCHEN/api/v1/settings/api-keys/{id}

CRM — Leads, Deals & Pipeline /api/leads

Vollständiges CRUD über Leads, Deals, Pipelines, Phasen, Labels und Quellen – samt ihrer Aufgaben, Anrufe, Dateien, Notizen und Produkte. (79 Endpunkte)

LÖSCHEN/api/deal-call/delete/{call_id}
POST/api/deal-call/store
POST/api/deal-call/update/{call_id}
POST/api/deal-client/store/{deal_id}
LÖSCHEN/api/deal-client/{deal_id}/delete/{client_id}
POST/api/deal-discussion/store/{deal_id}
POST/api/deal-email/store/{deal_id}
POST/api/deal-file/store/{deal_id}
LÖSCHEN/api/deal-file/{deal_id}/delete/{file_id}
POST/api/deal-source/store/{deal_id}
LÖSCHEN/api/deal-source/{deal_id}/delete/{source_id}
POST/api/deal-stage/create
LÖSCHEN/api/deal-stage/delete/{id}
POST/api/deal-stage/update/{id}
GET/api/deal-stages
POST/api/deal-task/create
LÖSCHEN/api/deal-task/delete/{id}
POST/api/deal-task/update/{id}
POST/api/deal-user/store/{deal_id}
LÖSCHEN/api/deal-user/{deal_id}/delete/{user_id}
POST/api/deal/add-label/{id}
POST/api/deal/assign-products/{deal_id}
POST/api/deal/create
LÖSCHEN/api/deal/delete/{id}
GET/api/deal/show/{id}
POST/api/deal/update/{id}
LÖSCHEN/api/deal/{deal_id}/products/{product_id}
GET/api/deals
POST/api/label/create
LÖSCHEN/api/label/delete/{id}
POST/api/label/update/{id}
GET/api/labels
LÖSCHEN/api/lead-call/delete/{call_id}
POST/api/lead-call/store
POST/api/lead-call/update/{call_id}
POST/api/lead-discussion/store/{lead_id}
POST/api/lead-email/store/{lead_id}
POST/api/lead-file/store/{lead_id}
LÖSCHEN/api/lead-file/{lead_id}/delete/{file_id}
POST/api/lead-source/store/{lead_id}
LÖSCHEN/api/lead-source/{lead_id}/delete/{source_id}
POST/api/lead-stage/create
LÖSCHEN/api/lead-stage/delete/{id}
POST/api/lead-stage/update/{id}
GET/api/lead-stages
POST/api/lead-task/create
LÖSCHEN/api/lead-task/delete/{id}
POST/api/lead-task/update/{id}
POST/api/lead-user/store/{lead_id}
LÖSCHEN/api/lead-user/{lead_id}/delete/{user_id}
POST/api/lead/add-label/{id}
POST/api/lead/assign-products/{lead_id}
POST/api/lead/convert-to-deal/{id}
POST/api/lead/create
LÖSCHEN/api/lead/delete/{id}
GET/api/lead/get-request-data
GET/api/lead/get-users
POST/api/lead/home
POST/api/lead/lead-create-update
POST/api/lead/lead-delete
POST/api/lead/lead-details
POST/api/lead/lead-stage-create-update
POST/api/lead/lead-stage-update
POST/api/lead/lead-stages
POST/api/lead/leadboard
POST/api/lead/pipeline-create-update
GET/api/lead/pipelines
GET/api/lead/show/{id}
POST/api/lead/update/{id}
LÖSCHEN/api/lead/{lead_id}/products/{product_id}
GET/api/leads
POST/api/pipeline/create
LÖSCHEN/api/pipeline/delete/{id}
POST/api/pipeline/update/{id}
GET/api/pipelines
POST/api/source/create
LÖSCHEN/api/source/delete/{id}
POST/api/source/update/{id}
GET/api/sources

Verkäufe /api/sales/sales-orders

Opportunities, Angebote, Besprechungen, Verkaufsaufträge und Lagerabfragen. (23 Endpunkte)

GET/api/sales/RequestData
POST/api/sales/get-warehouse-products
GET/api/sales/home
LÖSCHEN/api/sales/meeting/destroy/{id}
POST/api/sales/meeting/store
POST/api/sales/meeting/update/{id}
GET/api/sales/meetings
GET/api/sales/opportunities
LÖSCHEN/api/sales/opportunities/delete/{id}
POST/api/sales/opportunities/update/{id}
POST/api/sales/opportunitity/store
POST/api/sales/parent-records
GET/api/sales/quotes
LÖSCHEN/api/sales/quotes/destroy/{id}
POST/api/sales/quotes/store
POST/api/sales/quotes/update/{id}
GET/api/sales/quotes/{id}
LÖSCHEN/api/sales/sales-order/delete/{id}
POST/api/sales/sales-order/store
POST/api/sales/sales-order/update/{id}
GET/api/sales/sales-orders
GET/api/sales/sales-orders/{id}
GET/api/sales/warehouses

Verkaufsangebote /api/sales-proposal

Angebote entwerfen, senden, akzeptieren/ablehnen und in Rechnungen umwandeln. (9 Endpunkte)

GET/api/sales-proposal
POST/api/sales-proposal/accept/{proposal_id}
POST/api/sales-proposal/convert-to-invoice/{proposal_id}
POST/api/sales-proposal/create
LÖSCHEN/api/sales-proposal/delete/{proposal_id}
POST/api/sales-proposal/reject/{proposal_id}
POST/api/sales-proposal/sent/{proposal_id}
GET/api/sales-proposal/show/{proposal_id}
POST/api/sales-proposal/update/{proposal_id}

Sales invoices /api/sales-invoice

Verkaufsrechnungen auflisten, erstellen, aktualisieren, löschen und buchen. (6 Endpunkte)

GET/api/sales-invoice
POST/api/sales-invoice/create
LÖSCHEN/api/sales-invoice/delete/{invoice_id}
POST/api/sales-invoice/post/{invoice_id}
GET/api/sales-invoice/show/{invoice_id}
POST/api/sales-invoice/update/{invoice_id}

Retouren von Verkaufsrechnungen /api/sales-invoice-return

Verkaufsrechnungs-Rückgaben erstellen, genehmigen und abschließen. (6 Endpunkte)

GET/api/sales-invoice-return
POST/api/sales-invoice-return/approve/{return_id}
POST/api/sales-invoice-return/complete/{return_id}
POST/api/sales-invoice-return/create
LÖSCHEN/api/sales-invoice-return/delete/{return_id}
GET/api/sales-invoice-return/show/{return_id}

Einkaufsrechnungen /api/purchase-invoice

Eingangsrechnungen auflisten, erstellen, aktualisieren, löschen und buchen. (6 Endpunkte)

GET/api/purchase-invoice
POST/api/purchase-invoice/create
LÖSCHEN/api/purchase-invoice/delete/{invoice_id}
POST/api/purchase-invoice/post/{invoice_id}
GET/api/purchase-invoice/show/{invoice_id}
POST/api/purchase-invoice/update/{invoice_id}

Einkaufsrückgaben /api/purchase-return

Erstellen, genehmigen und schließen Sie Einkaufsretouren ab. (6 Endpunkte)

GET/api/purchase-return
POST/api/purchase-return/approve/{return_id}
POST/api/purchase-return/complete/{return_id}
POST/api/purchase-return/create
LÖSCHEN/api/purchase-return/delete/{return_id}
GET/api/purchase-return/show/{return_id}

Buchhaltung /api/chart-of-accounts

Kunden, Lieferanten, Bankkonten, Kontenplan, Einnahmen, Ausgaben, Zahlungen, Gut-/Lastschriften und Überweisungen. (37 Endpunkte)

GET/api/account-types
GET/api/bank-accounts
POST/api/bank-accounts/create
LÖSCHEN/api/bank-accounts/delete/{id}
POST/api/bank-accounts/update/{id}
GET/api/bank-transactions
GET/api/bank-transfers
GET/api/chart-of-accounts
GET/api/credit-notes
GET/api/customer-payments
GET/api/customers
POST/api/customers/create
LÖSCHEN/api/customers/delete/{id}
POST/api/customers/update/{id}
GET/api/debit-notes
GET/api/expense-categories
GET/api/expenses
POST/api/expenses/approve/{id}
POST/api/expenses/create
LÖSCHEN/api/expenses/delete/{id}
POST/api/expenses/post/{id}
POST/api/expenses/update/{id}
GET/api/get-clients
GET/api/get-vendors
GET/api/gl-accounts
GET/api/revenue-categories
GET/api/revenues
POST/api/revenues/approve/{id}
POST/api/revenues/create
LÖSCHEN/api/revenues/delete/{id}
POST/api/revenues/post/{id}
POST/api/revenues/update/{id}
GET/api/vendor-payments
GET/api/vendors
POST/api/vendors/create
LÖSCHEN/api/vendors/delete/{id}
POST/api/vendors/update/{id}

Produkte & Dienstleistungen /api/products

Produkte, Kategorien, Steuern, Einheiten und Bestand. (20 Endpunkte)

GET/api/product-service/items
POST/api/product-stock/add
GET/api/product-stocks
GET/api/product/category
POST/api/product/category/create
LÖSCHEN/api/product/category/delete/{id}
POST/api/product/category/update/{id}
POST/api/product/create
LÖSCHEN/api/product/delete/{id}
GET/api/product/detail/{id}
POST/api/product/update/{id}
GET/api/products
GET/api/tax
POST/api/tax/create
LÖSCHEN/api/tax/delete/{id}
POST/api/tax/update/{id}
POST/api/unit/create
LÖSCHEN/api/unit/delete/{id}
POST/api/unit/update/{id}
GET/api/units

Lager & Bestand /api/warehouse

Lager und Bestandsübertragungen. (9 Endpunkte)

GET/api/transfer
POST/api/transfer/create
LÖSCHEN/api/transfer/delete/{transfer_id}
GET/api/transfer/request-data
GET/api/warehouse
POST/api/warehouse/create
LÖSCHEN/api/warehouse/delete/{warehouse_id}
GET/api/warehouse/product/{warehouse_id}
POST/api/warehouse/update/{warehouse_id}

Projekte, Aufgaben & Bugs /api/projects

Projekte, Meilensteine, Task-Boards, Aufgaben, Teilaufgaben, Bugs und Berichte. (45 Endpunkte)

GET/api/bug-status-list
GET/api/get-projects
POST/api/project/bug-stage/create
LÖSCHEN/api/project/bug-stage/delete/{id}
POST/api/project/bug-stage/order
POST/api/project/bug-stage/update/{id}
GET/api/project/bug-stages
POST/api/project/bug/create/{project_id}
GET/api/project/bug/show/{bug_id}
POST/api/project/bug/{bug_id}/comment/create
LÖSCHEN/api/project/bug/{id}/comment/delete
GET/api/project/bug/{project_id}
LÖSCHEN/api/project/client/delete/{id}
POST/api/project/client/invite
GET/api/project/clients
LÖSCHEN/api/project/delete/{id}
POST/api/project/file/create
LÖSCHEN/api/project/file/delete/{id}
LÖSCHEN/api/project/member/delete/{id}
POST/api/project/milestone/create
LÖSCHEN/api/project/milestone/delete/{id}
POST/api/project/milestone/update/{id}
GET/api/project/milestones
GET/api/project/report/{id}
GET/api/project/reports
GET/api/project/show/{id}
POST/api/project/task-stage/create
LÖSCHEN/api/project/task-stage/delete/{id}
POST/api/project/task-stage/order
POST/api/project/task-stage/update/{id}
GET/api/project/task-stages
POST/api/project/task-subtask/create/{task_id}
POST/api/project/task-subtask/update/{subtask_id}
LÖSCHEN/api/project/task/comment/delete/{comment_id}
GET/api/project/task/show/{id}
POST/api/project/task/{task_id}/comment/create
POST/api/project/update/{id}
GET/api/project/{id}/task-board
POST/api/project/{id}/task/create
POST/api/project/{id}/task/update/{task_id}
LÖSCHEN/api/project/{project_id}/bug/delete/{bug_id}
POST/api/project/{project_id}/bug/update/{bug_id}
LÖSCHEN/api/project/{project_id}/task/delete/{task_id}
GET/api/projects
POST/api/projects/create

Kassensystem /api/pos

POS-Bestellungen und Bestelldetails. (2 Endpunkte)

GET/api/pos
GET/api/pos/show/{id}

Support-Desk /api/support-ticket/tickets

Tickets und Antworten, FAQs und Wissensdatenbank-Artikel. (16 Endpunkte)

POST/api/support-ticket/faq/delete/{faq_id}
POST/api/support-ticket/faq/update/{faq_id}
GET/api/support-ticket/faqs
POST/api/support-ticket/faqs/store
GET/api/support-ticket/get-request-data
GET/api/support-ticket/home
POST/api/support-ticket/knowledge/delete/{knowledge_id}
POST/api/support-ticket/knowledge/store
POST/api/support-ticket/knowledge/update/{knowledge_id}
GET/api/support-ticket/knowledges
POST/api/support-ticket/ticket/add-reply/{ticket_id}
POST/api/support-ticket/ticket/delete/{ticket_id}
POST/api/support-ticket/ticket/note/store/{ticket_id}
POST/api/support-ticket/ticket/store
POST/api/support-ticket/ticket/update/{ticket_id}
GET/api/support-ticket/tickets

Taskly /api/taskly/projects

Taskly-Projekte und -Aufgaben für das schlanke Projektmodul. (18 Endpunkte)

GET/api/taskly/home
POST/api/taskly/project-activity
POST/api/taskly/project-create-update
POST/api/taskly/project-delete
POST/api/taskly/project-details
LÖSCHEN/api/taskly/project-file-delete/{id}
POST/api/taskly/project-file-upload
POST/api/taskly/project-list
POST/api/taskly/project-status-update
GET/api/taskly/projects
GET/api/taskly/projects/{project}/tasks
POST/api/taskly/task-create-update
POST/api/taskly/task-delete
POST/api/taskly/task-details
POST/api/taskly/task-list
POST/api/taskly/task-stage-update
POST/api/taskly/taskboard
GET/api/taskly/users

Zeiterfassung /api/add-tracker

Zeiterfassung starten und stoppen. (3 Endpunkte)

POST/api/add-tracker
POST/api/stop-tracker
POST/api/tracker-login

Benutzer & Rollen /api/users

Verwalten Sie Workspace-Nutzer und lesen Sie Rollen. (8 Endpunkte)

GET/api/roles
LÖSCHEN/api/user/delete/{id}
POST/api/user/reset-password/{id}
POST/api/user/store
POST/api/user/update/{id}
PUT/api/user/verify/{id}
GET/api/users
GET/api/users/log

Personalwesen & Lohnabrechnung /api/employees

Mitarbeiter, Anwesenheit, Urlaub, Gehaltsabrechnung sowie der vollständige HR-Datensatz (Filialen, Abteilungen, Feiertage, Auszeichnungen und mehr). (44 Endpunkte)

GET/api/acknowledgments
GET/api/announcements
POST/api/attendance/create
LÖSCHEN/api/attendance/delete/{attendance_id}
POST/api/attendance/update/{attendance_id}
GET/api/attendances
GET/api/awards
GET/api/branches
GET/api/complaints
GET/api/departments
GET/api/designations
GET/api/document-types
GET/api/employee-transfers
POST/api/employee/create
LÖSCHEN/api/employee/delete/{id}
GET/api/employee/show/{id}
POST/api/employee/update/{id}
GET/api/employees
GET/api/events
GET/api/holidays
GET/api/hrm-documents
POST/api/hrm/attendence-history
POST/api/hrm/clock-in-out
POST/api/hrm/events
GET/api/hrm/get-leaves
GET/api/hrm/get-leaves-types
GET/api/hrm/holidays-list
GET/api/hrm/home
POST/api/hrm/leave-request
POST/api/leave-application/create
LÖSCHEN/api/leave-application/delete/{leaveapplication_id}
POST/api/leave-application/update-status/{leaveapplication_id}
POST/api/leave-application/update/{leaveapplication_id}
GET/api/leave-applications
GET/api/leave-balances
GET/api/leave-types
GET/api/payrolls
GET/api/payrolls/{payroll_id}
GET/api/payslip/{payroll_entry_id}
GET/api/promotions
GET/api/resignations
GET/api/shifts
GET/api/terminations
GET/api/warnings

Drittanbieter-API (v1) /api/v1/customers

Ein stabiler, versionierter Ausschnitt für No-Code-Tools wie Zapier – Kunden und Rechnungen. (7 Endpunkte)

GET/api/v1/customers
POST/api/v1/customers
GET/api/v1/customers/{id}
PUT/api/v1/customers/{id}
GET/api/v1/invoices
POST/api/v1/invoices
GET/api/v1/invoices/{id}

Öffentliche Endpunkte /api/public/plans

Nicht authentifizierte Helfer: der öffentliche Tarifkatalog und das einbettbare Lead-Erfassungs-Widget & Partner-Badge. (4 Endpunkte)

GET/api/badge/{token}
GET/api/public/plans
POST/api/widget/lead
GET/api/widget/{token}

White-Label-Plattform /api/wl/plans

Server-zu-Server-Endpunkte, die von White-Label-Instanzen für Abrechnung und Stripe Connect verwendet werden (Token-authentifiziert). (6 Endpunkte)

POST/api/wl/checkout
POST/api/wl/connect/onboard
GET/api/wl/connect/status
GET/api/wl/plans
POST/api/wl/subscription/{stripe_subscription_id}/cancel
POST/api/wl/webhook-callback

Integrations-Endpunkte /api/microsofttodo

Hilfsendpunkte für verbundene Integrationen (Microsoft To Do, Vonage SMS, Facebook-Beiträge). (3 Endpunkte)

GET/api/facebookpost
GET/api/microsofttodo
GET/api/vonagesms

Mehr Endpunkte

Zusätzliche registrierte Endpunkte. (1 Endpunkt)

GET/api/agents/{agent}/outstanding-commissions