REST API Home

Learn to use ProcessMaker IDP

The ProcessMaker IDP REST API is organized around REST. This API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication. All datastore types that have an ID attribute are directly available through the API without any extra configuration.

Frequently Used GET Method Endpoints for Entity Objects

Get a collection of entity objects by their type.

Get one type's entity object by its unique ID.

Gets the content (binary) of a type's entity object by its unique ID.

Other Frequently Used Endpoints for Entity Objects

Create an entity object.

Update one type's entity object by its unique ID.

Delete one type's entity object by its unique ID.