Developers
Build on Oris Work.
The Oris Work API lets you read and write business data programmatically — trigger workflows, sync entities across systems, and build integrations with your existing tools.
CRM Data
Read and write companies, contacts, deals, activities.
Webhook Events
Receive real-time webhook events on entity changes.
Connector Framework
Connect your accounting, HR, or ERP system.
curl -X POST https://api.oriswork.com/v1/companies \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sharma Advisory Ltd",
"industry": "Professional Services",
"domain_name": "sharmaadvisory.in",
"employees": 22
}'Authentication
All requests authenticate with a Bearer token. Tokens are generated per workspace in Settings → API Keys.
Base URL
api.oriswork.com/v1
Auth method
Authorization: Bearer {api_key}
Rate limits
Growth: 100 req/min · Enterprise: custom
Error format
{ error: { code, message, request_id } }
API Reference
| Method | Endpoint | Description | Plan |
|---|---|---|---|
| GET | /companies | List all companies with pagination, search, and filters | Growth+ |
| POST | /companies | Create a new company record | Growth+ |
| GET | /companies/:id | Retrieve a single company with related records | Growth+ |
| PATCH | /companies/:id | Update company fields (partial update) | Growth+ |
| GET | /contacts | List contacts with filtering by company | Growth+ |
| POST | /contacts | Create a contact, optionally linked to a company | Growth+ |
| GET | /deals | List deals with stage filtering and kanban ordering | Growth+ |
| POST | /deals | Create a new deal in a specified stage | Growth+ |
| PATCH | /deals/:id | Move a deal to a different stage | Growth+ |
| GET | /activities | List activities filtered by type, status, linked record | Growth+ |
| POST | /activities | Log an activity (note, call, task, email, meeting, file) | Growth+ |
| GET | /projects | List projects with member and task summary | Growth+ |
| POST | /projects | Create a new project linked to a company | Growth+ |
| POST | /webhooks | Register a webhook URL for event delivery | Enterprise |
| GET | /connectors | List available accounting connectors and status | Growth+ |
| POST | /connectors/:id/sync | Trigger a manual sync for a connector | Growth+ |
Webhook Events
Register webhook URLs to receive real-time notifications when data changes.
| Event | Triggered When | Key Payload Fields |
|---|---|---|
| company.created | New company created | company_id, name, vertical, created_by |
| company.updated | Company record updated | company_id, changed_fields, updated_by |
| deal.stage_changed | Deal moved to a new stage | deal_id, from_stage, to_stage, moved_by |
| deal.won | Deal marked as Won | deal_id, amount, currency, closed_by |
| activity.created | Activity logged (any type) | activity_id, type, linked_to, created_by |
| project.completed | Project status set to Completed | project_id, company_id, completion_date |
| invoice.paid | Payment confirmed via Razorpay/Stripe | invoice_id, amount, currency, paid_at |
| portal.message_sent | Client sends portal message | company_id, message_preview, sent_at |
| connector.sync_complete | Accounting connector sync done | connector_id, records_synced, errors_count |
Accounting Connectors
8 pre-built connectors. Open API/Webhook for anything else.
SDKs
Official client libraries for your language.
JavaScript / TypeScript
v1.0npm install @orisintelligence/oriswork-sdk
Python
v1.0pip install oriswork
PHP
Plannedcomposer require orisintelligence/oriswork-php