# REST API Home

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

<table data-view="cards"><thead><tr><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="/pages/YNe7Ufw6BnIkapbgISoE#gets-a-collection-of-entity-objects-by-their-type."><strong>Get a collection of entity objects by their type.</strong></a></td><td></td><td></td><td><a href="/files/azc7mC4IjoserDdTrwsR">/files/azc7mC4IjoserDdTrwsR</a></td></tr><tr><td><a href="/pages/YNe7Ufw6BnIkapbgISoE#gets-one-types-entity-object-by-its-unique-id."><strong>Get one type's entity object by its unique ID.</strong></a></td><td></td><td></td><td><a href="/files/WBjSMwovCxvBTpo4UdWU">/files/WBjSMwovCxvBTpo4UdWU</a></td></tr><tr><td><a href="/pages/YNe7Ufw6BnIkapbgISoE#gets-the-content-binary-of-a-types-entity-object-by-its-unique-id."><strong>Gets the content (binary) of a type's entity object by its unique ID.</strong></a></td><td></td><td></td><td><a href="/files/GK731FG59v76hxPiSEoe">/files/GK731FG59v76hxPiSEoe</a></td></tr></tbody></table>

## Other Frequently Used Endpoints for Entity Objects

<table data-view="cards"><thead><tr><th></th><th data-hidden></th><th data-hidden></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="/pages/YNe7Ufw6BnIkapbgISoE#creates-an-entity-object-by-specifying-its-entity-type."><strong>Create an entity object.</strong></a></td><td></td><td></td><td><a href="/files/3vTdvHPNBrfpQ0vgdfUX">/files/3vTdvHPNBrfpQ0vgdfUX</a></td></tr><tr><td><a href="/pages/YNe7Ufw6BnIkapbgISoE#updates-one-types-entity-object-by-its-unique-id."><strong>Update one type's entity object by its unique ID.</strong></a></td><td></td><td></td><td><a href="/files/eEjlGqmEbPSzaXVRrB43">/files/eEjlGqmEbPSzaXVRrB43</a></td></tr><tr><td><a href="/pages/YNe7Ufw6BnIkapbgISoE#deletes-one-types-entity-object-by-its-unique-id."><strong>Delete one type's entity object by its unique ID.</strong></a></td><td></td><td></td><td><a href="/files/r4C7Ti0KA3xxuJFGTbM1">/files/r4C7Ti0KA3xxuJFGTbM1</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://processmaker.gitbook.io/idp/idp-developer/rest-api-home.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.