← All documentation
API & integrations
Customers API
Create, list, search, read, and update customer records — the primary lead ingestion endpoint.
POST /api/v1/customers
Create a customer (requires write scope). Respects plan customer limits on Starter.
curl -X POST https://springos.co/api/v1/customers \
-H "Authorization: Bearer sk_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"firstName": "Jane",
"lastName": "Doe",
"email": "jane@example.com",
"phone": "555-0100",
"address": "123 Main St",
"notes": "Lead from website"
}'GET /api/v1/customers
List customers. Query params: q (search), limit (max 100, default 50). Requires read scope.
GET /api/v1/customers/{id}
Fetch one customer by ID. Scoped to your company only.
PATCH /api/v1/customers/{id}
Partial update of name, email, phone, address, or notes. Requires write scope.
Successful creates set source to api and may fire customer.created webhooks.