Introduction

BytePhase is repair-shop management software. Shops use it to log repairs, track them through statuses, invoice customers and keep in touch. The integration API is the door into that workflow from the outside: it lets a website, a form builder, a marketplace listing or an automation tool hand an enquiry to the shop, and lets automation tools read what has recently happened.

Who this is for

You are…	Start here
A developer wiring a website, app or script to a BytePhase workspace	Quick Start, then the API reference
A shop owner or agency using Zapier or n8n	Zapier or n8n
Running a WordPress site	WordPress — no code needed
Receiving leads from Typeform, JotForm, Tally.so, IndiaMART or Justdial	Inbound Forms

What you can build

• Website enquiry → lead. A contact or quote form on any site creates a lead in the workspace, assigned and ready to follow up.
• Booking form → self check-in. A “book a repair” form creates a self check-in with the device details, so the customer is already in the queue when they walk in.
• Form builders without code. Point Typeform, JotForm or Tally.so at a receiving URL and map the fields once in BytePhase.
• Marketplace leads. IndiaMART and Justdial enquiries arrive as leads automatically.
• Automation. From Zapier or n8n, react to new repairs, customers, leads, payments and status changes, look up customers, and create leads.

Every record created through the API goes through the same path as one created in the app, so assignment, duplicate handling and notifications behave identically.

What is not available

The documented surface is deliberately small. Only what an integration key can already reach is documented, and only two kinds of record can be created: leads and self check-ins.

Not available, and not planned for this version:

• Invoices, quotations, payment creation, inventory, products, suppliers, employees, reports
• Workspace settings, billing, subscriptions, roles and permissions
• Bulk import or export, deletion of any record
• Sending SMS, WhatsApp or email
• Outbound webhooks (Zapier and n8n currently poll)

A key can never read or change anything outside the documented endpoints, whatever it is used for. See Authentication for what each type of key can do.

How the API behaves

• JSON in, JSON out. Field names are snake_case.
• One key per integration, created and managed in BytePhase under Settings → Integrations. There is no developer dashboard on this site.
• Every write response carries an X-Request-Id header. Quote it when you contact support.
• Errors have a stable machine-readable code. See Errors.
• Writes accept an Idempotency-Key so retries are safe. See Idempotency.
• 60 requests per minute per key. See Rate Limits.
• Timestamps are ISO 8601 in UTC. See Pagination & Data.
• Unknown fields in a submission are not rejected — they are kept as custom fields on the record. See Custom Integrations.

Versioning

The documented endpoints are a contract: fields and status codes described here will not be removed or change meaning without a changelog entry and a deprecation period. New endpoints and new optional fields may be added at any time — ignore fields you do not recognise. The Changelog records every change.