# Zoho Bigin Integration via LowCodeAPI

**Last Updated**: February 10, 2026

## Overview
CRM and business automation

**Categories:**
- {'id': 'zoho-suite', 'name': 'Zoho Suite', 'description': 'Zoho business applications and productivity tools', 'priority': 17}

## Base Endpoint
https://api.lowcodeapi.com/zohobigin

**Important**: Always include the provider name in the URL path after `api.lowcodeapi.com/`

## Authentication
**Type:** OAUTH2.0

**Official Documentation:** https://www.bigin.com/developer/docs/apis/

## URL Format (Important)

LowCodeAPI supports two URL formats. **Always try the New Format first**, then fall back to Old Format if needed.

### New Format (Priority)
- Path parameters stay in the URL path
- Do NOT include path parameters as query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/{id}?api_token=XXX`

### Old Format (Fallback)
- Path parameters become query parameters
- Example: `https://api.lowcodeapi.com/{provider}/resource/id?id={id}&api_token=XXX`

### Decision Flow for AI Agents
1. Always use **New Format** first - keep path parameters in the URL path
2. If you get a 404 or error, try **Old Format** with sanitized path
3. Log which format worked for future requests to this provider

## API Categories

## Common Endpoints

### Get all profiles data

**Method:** GET
**LowCodeAPI Path:** /bigin/v2/settings/profiles

**New Format URL:**
https://api.lowcodeapi.com/zohobigin/bigin/v2/settings/profiles?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohobigin/bigin/v2/settings/profiles?api_token=YOUR_API_TOKEN

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohobigin/bigin/v2/settings/profiles?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.bigin.com/developer/docs/apis/v2/get-profiles.html

### Get all roles data

**Method:** GET
**LowCodeAPI Path:** /bigin/v2/settings/roles

**New Format URL:**
https://api.lowcodeapi.com/zohobigin/bigin/v2/settings/roles?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohobigin/bigin/v2/settings/roles?api_token=YOUR_API_TOKEN

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohobigin/bigin/v2/settings/roles?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.bigin.com/developer/docs/apis/v2/get-roles.html

### Get users data

**Method:** GET
**LowCodeAPI Path:** /bigin/v2/users

**New Format URL:**
https://api.lowcodeapi.com/zohobigin/bigin/v2/users?api_token=YOUR_API_TOKEN

**Old Format URL:**
https://api.lowcodeapi.com/zohobigin/bigin/v2/users?api_token=YOUR_API_TOKEN

**Example Request (New Format):**

```bash
curl -X GET 'https://api.lowcodeapi.com/zohobigin/bigin/v2/users?api_token=YOUR_API_TOKEN'
```

**Official Documentation:** https://www.bigin.com/developer/docs/apis/v2/get-users.html


## Usage Examples

### Example 1: Basic API Request (New Format)

Making a simple GET request to retrieve resources:

```bash
# Get a list of resources - no path parameters needed
curl -X GET "https://api.lowcodeapi.com/zohobigin/endpoint?api_token=YOUR_API_TOKEN"
```

### Example 2: Request with Path Parameters (New Format)

Retrieving a specific resource using its ID:

```bash
# Get specific resource by ID - replace RESOURCE_ID with actual ID from previous response
curl -X GET "https://api.lowcodeapi.com/zohobigin/endpoint/{RESOURCE_ID}?api_token=YOUR_API_TOKEN"
# Note: RESOURCE_ID typically comes from a previous list request or from the provider dashboard
```

### Example 3: POST Request with Body (New Format)

Creating a new resource:

```bash
# Create a new resource
curl -X POST "https://api.lowcodeapi.com/zohobigin/endpoint?api_token=YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"field": "value", "another_field": "another_value"}'
```

## Error Handling

LowCodeAPI returns standard HTTP status codes. Common errors:

| Status Code | Description |
|-------------|-------------|
| 200 | Success - Request completed successfully |
| 400 | Bad Request - Invalid parameters or request body |
| 401 | Unauthorized - Invalid or missing API token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Endpoint or resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Server Error - Provider API error |

All error responses include error details:

```json
{
  "data": {
    "error": {
      "message": "Error description",
      "code": "ERROR_CODE"
    }
  }
}
```

## Complete Endpoint Reference

| Endpoint | Method | Category |
|----------|--------|----------|
| Get all profiles data | GET | Profiles |
| Get all roles data | GET | Roles |
| Get users data | GET | Users |

## API Definition Endpoints

You can fetch the complete API specification for this provider:

**New Format (OpenAPI spec):**
```bash
curl 'https://backend.lowcodeapi.com/zohobigin/openapi'
```

**Old Format (API definition):**
```bash
curl 'https://backend.lowcodeapi.com/zohobigin/definition'
```

## Response Format

All responses are wrapped in a `data` key:

```json
{
  "data": {
    // Actual response from provider (object or array)
  }
}
```