Supported Operations

Requests

# Authenticate
curl -X POST -H "Content-Type: application/json" -c cookies.txt \
    -d '{"jsonrpc": "2.0", "params": {"db": "YOUR_DATABASE", "login": "USER@EXAMPLE.COM", "password": "YOUR_USER_PASSWORD"}}' \
    https://your-odoo-instance.com/web/session/authenticate

# Search
curl -s -X GET -H "Content-Type: application/json" -b cookies.txt \
    -d "domain=[(\"id\",\">\",0)]&limit=5ℴ=id" \
    "https://your-odoo-instance.com/api/partner/rest"

# Create
curl -s -X POST -H "Content-Type: application/json" -b cookies.txt \
    -d '{"name": "Test Partner (CRUD Demo Bash)"}' \
    "https://your-odoo-instance.com/api/partner/rest"

# Read
curl -s -X GET -H "Content-Type: application/json" -b cookies.txt \
    "https://your-odoo-instance.com/api/partner/rest/NnRZn"

# Update
curl -s -X PATCH -H "Content-Type: application/json" -b cookies.txt \
    -d '{"name": "Test Partner (CRUD Demo Bash) (Updated)"}' \
    "https://your-odoo-instance.com/api/partner/rest/NnRZn"

# Delete
curl -s -X DELETE -H "Content-Type: application/json" -b cookies.txt \
    "https://your-odoo-instance.com/api/partner/rest/NnRZn"

Reponses

// SEARCH Response:
{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "length": 36,
        "records": [
            {
                "id": "NnRZn",
                "email": "brandon.freeman55@example.com",
                "image_128": "/api/image/2/res.partner/NnRZn/image_128",
                "name": "Brandon Freeman"
            },
            ...
        ]
    }
}

// CREATE Response:
{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "id": "P2y3b",
        "company_id": [],
        "email": "",
        "image_1024": "",
        "image_128": "",
        "name": "Test Partner (CRUD Demo Bash)",
        "phone": ""
    }
}

// READ Response:
{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "id": "8blEP",
        "company_id": [],
        "email": "azure.Interior24@example.com",
        "image_1024": "/api/image/2/res.partner/8blEP/image_1024",
        "image_128": "/api/image/2/res.partner/8blEP/image_128",
        "name": "Azure Interior",
        "phone": "(870)-931-0505"
    }
}

// UPDATE Response:
{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "id": "8blEP",
        "company_id": [],
        "email": "azure.Interior24@example.com",
        "image_1024": "/api/image/2/res.partner/8blEP/image_1024",
        "image_128": "/api/image/2/res.partner/8blEP/image_128",
        "name": "Test Partner (CRUD Demo Bash) (Updated)",
        "phone": "(870)-931-0505"
    }
}

// DELETE Response:
{
    "jsonrpc": "2.0",
    "id": null,
    "result": [
        "NnRZn"
    ]
}

Get Access Token

# Request
curl -X POST \
  -F client_id=your_client_id \
  -F client_secret=your_secret \
  https://your-odoo-instance.com/api/oauth2/token

# Response
{
    "access_token": "q88Oj31Vc9OnpT85X7CjIsHpI4BI36L4Hfv...",
    "token_type": "Bearer",
    "expires_in": 1800,
    "scope": "create read update delete search rpc"
}

Use Access Token

# Request
curl -X GET \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer q88Oj31Vc9OnpT85X7CjIsHpI4BI36L4Hfv..." \
  https://your-odoo-instance.com/api/partner/rest

JWT Token Endpoint

# Request
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"client_id": "your_client_id", "client_secret": "your_secret"}' \
  https://your-odoo-instance.com/api/jwt/token

# Response
{
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer",
    "expires_in": 1800,
    "scope": "create read update delete search rpc"
}

Use Access Token

# Request
curl -X GET \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  https://your-odoo-instance.com/api/partner/rest

Example

# Without ID Obfuscation
{"id": 42, "name": "John Doe"}

# With ID Obfuscation enabled
{"id": "gY5kp8", "name": "John Doe"}

Available Scopes

• create - Create new records
• read - Read individual records
• update - Update existing records
• delete - Delete records
• search - Search and list records
• rpc - Call custom methods (RPC)

Example: Bulk Create

# Request
POST /api/partners
Content-Type: application/json

[
    {"name": "Partner A", "email": "a@example.com"},
    {"name": "Partner B", "email": "b@example.com"}
]

# Response: Array of created records
[
    {"id": "abc123", "name": "Partner A", "email": "a@example.com"},
    {"id": "def456", "name": "Partner B", "email": "b@example.com"}
]

Example: Bulk Update

# Update multiple records with same values
PATCH /api/partners
{"ids": ["abc123", "def456"], "active": false}

# Update multiple records with different values
PATCH /api/partners
[
    {"id": "abc123", "phone": "123-456-7890", "active": false},
    {"id": "def456", "phone": "098-765-4321", "active": false}
]

Example

# Database field: partner_id
# Alias: customer

# API Request can use alias:
POST /api/orders
{"customer": "gY5kp8", "order_total": 150.00}

# API Response uses alias:
{"customer": "gY5kp8", "order_total": 150.00}

Example

# Without related fields:
{"id": "abc123", "country_id": 42}

# With related fields configured (country_id fields: name, code):
{"id": "abc123", "country_id": [42, {"name": "United States", "code": "US"}]}

Example

# Single API for multiple models
GET /api/:model

# Access different models:
GET /api/res.partner
GET /api/sale.order
GET /api/product.product

Choose between two authentication modes for each API:

Query Parameters