For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.10 (unreleased)

API reference

Technical Preview

The PHP SDK is a technical preview. Its API surface may still evolve and changes may not follow semantic versioning. Pin an exact version if you need stability.

The SDK exposes 243 operations across 41 API groups. Every operation is available directly on the client (the flat facade) and through the typed api() accessor:

$client = CamundaClient::fromEnvironment();

// Flat facade — every operation is a method on the client:
$topology = $client->getTopology();

// Or via the typed API-group accessor:
$jobs = $client->api(\Camunda\Orchestration\Api\Api\JobApi::class);
API groupOperations
Ad Hoc Sub Process API1
Agent Definition API2
Agent Instance API5
Audit Log API2
Authentication API2
Authorization API5
Backup API22
Batch Operation API6
Clock API2
Cluster API7
Cluster Variable API9
Conditional API1
Decision Definition API4
Decision Instance API4
Decision Requirements API3
Document API5
Element Instance API5
Exporting API6
Expression API1
Form API1
Global Listener API5
Group API15
Incident API5
Job API12
License API1
Mapping Rule API5
Message API2
Message Subscription API2
Process Definition API9
Process instance API23
Recovery API5
Resource API6
Role API17
Secret API2
Setup API1
Signal API1
System API2
Tenant API20
User API5
User Task API10
Variable API2
Domain type system—