FactoryOS
Start 7-day trial
Developers

The FactoryOS API.

Read every enquiry into your ERP, or send leads into FactoryOS from your own forms and software. JSON over HTTPS, one key per system. Available on the Growth and Enterprise plans.

v1Base URL https://app.factoryos.co/api/v1
120requests a minute per key
100leads per page, at most

Authentication

Create a key in Settings > API keys. Give it the read scope, the write scope, or both. The key is shown once; store it in your server's secrets, never in a browser or an app.

Authorization: Bearer fos_your_key

Revoke a key from the same screen at any time. Requests with a revoked or expired key get 401.

List leads
GET /leads · read

Newest first. Filter by status, source and date.

ParameterMeaning
pagePage number, from 1.
per_page1 to 100. Default 50.
statusnew, contacted, qualified, converted, not_interested, lost or archived.
sourceWhere the lead came from, for example web_form, whatsapp, call or api.
sinceISO 8601 date or time. Leads created on or after it.
curl https://app.factoryos.co/api/v1/leads?status=new&per_page=20 \
  -H "Authorization: Bearer fos_your_key"
{
  "data": [
    {
      "id": "6f1c…",
      "created_at": "2026-11-10T17:32:08Z",
      "source": "web_form",
      "status": "new",
      "product_interest": "SS 316 slip-on flanges, 2 inch",
      "quantity": "500 pcs",
      "message": "Delivery Vadodara in 3 weeks.",
      "contact": { "name": "R. Mehta", "email": "…", "phone": "…", "city": "Vadodara", "country": "IN" },
      "company": "Mehta Process Equipment"
    }
  ],
  "page": 1,
  "per_page": 20,
  "has_more": true
}

Create a lead
POST /leads · write

Saved like a website enquiry with source api: your team gets the push alert and your follow-up sequences start. Send at least one of name, email or phone.

FieldLimit
name120 characters
emailA valid address
phoneAt least 6 digits, 24 characters
company160 characters
product_interest200 characters
quantity80 characters
message4,000 characters
curl -X POST https://app.factoryos.co/api/v1/leads \
  -H "Authorization: Bearer fos_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name":"R. Mehta","phone":"+91 98xxx xxxxx","company":"Mehta Process Equipment","product_interest":"SS 316 flanges","quantity":"500 pcs"}'

Answers 201 with the lead in data.

Errors

CodeWhen
400A parameter or field is not valid. The error text says which.
401The key is missing, wrong, revoked or expired.
403The key lacks the scope, or the plan does not include the API.
429More than 120 requests in a minute. Wait for the Retry-After seconds.
500Our side. Retry; nothing was saved.

Connecting an ERP?

Our team sets up SAP, Tally and other connections with your IT team on Enterprise.