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.

Create a company via the API
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

MethodEndpointDescriptionPlan
GET/companiesList all companies with pagination, search, and filtersGrowth+
POST/companiesCreate a new company recordGrowth+
GET/companies/:idRetrieve a single company with related recordsGrowth+
PATCH/companies/:idUpdate company fields (partial update)Growth+
GET/contactsList contacts with filtering by companyGrowth+
POST/contactsCreate a contact, optionally linked to a companyGrowth+
GET/dealsList deals with stage filtering and kanban orderingGrowth+
POST/dealsCreate a new deal in a specified stageGrowth+
PATCH/deals/:idMove a deal to a different stageGrowth+
GET/activitiesList activities filtered by type, status, linked recordGrowth+
POST/activitiesLog an activity (note, call, task, email, meeting, file)Growth+
GET/projectsList projects with member and task summaryGrowth+
POST/projectsCreate a new project linked to a companyGrowth+
POST/webhooksRegister a webhook URL for event deliveryEnterprise
GET/connectorsList available accounting connectors and statusGrowth+
POST/connectors/:id/syncTrigger a manual sync for a connectorGrowth+

Webhook Events

Register webhook URLs to receive real-time notifications when data changes.

EventTriggered WhenKey Payload Fields
company.createdNew company createdcompany_id, name, vertical, created_by
company.updatedCompany record updatedcompany_id, changed_fields, updated_by
deal.stage_changedDeal moved to a new stagedeal_id, from_stage, to_stage, moved_by
deal.wonDeal marked as Wondeal_id, amount, currency, closed_by
activity.createdActivity logged (any type)activity_id, type, linked_to, created_by
project.completedProject status set to Completedproject_id, company_id, completion_date
invoice.paidPayment confirmed via Razorpay/Stripeinvoice_id, amount, currency, paid_at
portal.message_sentClient sends portal messagecompany_id, message_preview, sent_at
connector.sync_completeAccounting connector sync doneconnector_id, records_synced, errors_count

Accounting Connectors

8 pre-built connectors. Open API/Webhook for anything else.

Tally Prime (India)
Zoho Books
QuickBooks Online
Xero
Busy Accounting
ERPNext / Frappe
SAP Business One
Open Webhook (any system)

SDKs

Official client libraries for your language.

JavaScript / TypeScript

v1.0

npm install @orisintelligence/oriswork-sdk

Python

v1.0

pip install oriswork

PHP

Planned

composer require orisintelligence/oriswork-php