2.3 KiB
2.3 KiB
Zoho Bigin Routing Reference
App name: zoho-bigin
Base URL proxied: www.zohoapis.com
API Path Pattern
/zoho-bigin/bigin/v2/{resource}
Common Endpoints
List Contacts
GET /zoho-bigin/bigin/v2/Contacts?fields=First_Name,Last_Name,Email
Get Contact
GET /zoho-bigin/bigin/v2/Contacts/{id}
Create Contact
POST /zoho-bigin/bigin/v2/Contacts
Content-Type: application/json
{
"data": [{
"Last_Name": "Smith",
"First_Name": "John",
"Email": "john@example.com"
}]
}
Update Contact
PUT /zoho-bigin/bigin/v2/Contacts
Content-Type: application/json
{
"data": [{
"id": "{record_id}",
"Phone": "+1-555-1234"
}]
}
Delete Contact
DELETE /zoho-bigin/bigin/v2/Contacts?ids={id1},{id2}
Search Contacts
GET /zoho-bigin/bigin/v2/Contacts/search?email=john@example.com
GET /zoho-bigin/bigin/v2/Contacts/search?criteria=(Last_Name:equals:Smith)
List Companies (Accounts)
GET /zoho-bigin/bigin/v2/Accounts?fields=Account_Name,Website
Get Users
GET /zoho-bigin/bigin/v2/users?type=ActiveUsers
Get Modules
GET /zoho-bigin/bigin/v2/settings/modules
Available Modules
| Module | API Name | Description |
|---|---|---|
| Contacts | Contacts |
Individual people |
| Companies | Accounts |
Organizations/businesses |
| Pipelines | Pipelines |
Sales opportunities/deals |
| Products | Products |
Items you sell |
| Tasks | Tasks |
To-do items |
| Events | Events |
Calendar appointments |
| Calls | Calls |
Phone call logs |
| Notes | Notes |
Notes attached to records |
Notes
- The
fieldsquery parameter is required for list operations - Module API names are case-sensitive (e.g.,
Contacts, notcontacts) - Companies are accessed via the
Accountsmodule - Sales opportunities are in the
Pipelinesmodule (notDeals) - Record IDs are numeric strings (e.g.,
7255024000000596045) - Maximum 200 records per page, 100 per create/update/delete
- Some modules (Tasks, Events, Calls, Notes) require additional OAuth scopes