Discovery

The discovery endpoint lets a client know which objects and capabilities a given OBAPI server supports. Not every server will implement all tiers.

This is the only endpoint that does not require authentication.

• Method: GET /obapi/v1

Response

{
    "obapi_version": "1.0",
    "provider": {
        "name": "My Company",
        "website": "https://example.com",
        "contact_email": "contact@example.com"
    },
    "software": {
        "name": "Dolibarr",
        "version": "20.0.0"
    },
    "capabilities": [
        "thirdparty",
        "contacts",
        "products",
        "proposals",
        "orders",
        "invoices",
        "creditnotes",
        "shipments",
        "download"
    ],
    "pagination": {
        "default_per_page": 50,
        "max_per_page": 200
    }
}

Capabilities

The capabilities array lists the object types this server supports. Clients should check this before calling endpoints.

Tier 1: thirdparty, contacts, products, proposals, orders, invoices, creditnotes, shipments, download

Tier 2: supplier-proposals, supplier-orders, supplier-invoices, receptions, contracts, interventions, tickets

Tier 3: projects, tasks, expense-reports, boms, manufacturing-orders, warehouses, members, categories

A server that only supports invoices could return:

{
    "obapi_version": "1.0",
    "provider": { "name": "Minimal Provider" },
    "capabilities": ["thirdparty", "invoices", "download"]
}