Pega API

You can use the Pega API to power client and mobile apps by using built-in Pega REST services. It includes case, assignment, and data APIs that let you leverage your Pega Platform applications. The APIs are secured by user credentials and TLS/SSL.

You can access the Pega API by clicking Resources > Pega API. In the API, you can do the following actions:

• List parameters
• View the JSON data model for each resource
• Test an API by clicking Try it out! to view the actual request URL, response body, response code, and response headers

API resources

The Pega API provides the following resources.

Assignments

• Get assignments or get next assignments
• Get details of a known assignment or the next assignment that is most urgent
• Perform assignment actions

Authenticate

• Verify user credentials

Cases

• Get cases
• Create a new case
• Get case details
• Update a case

Case types

• Get case types

Data

• Get data page contents
• Get data page metadata

Docs

• Get the complete documentation for the Pega API

Users

• Terminates all existing sessions in all nodes of the cluster for the given set of users

Open topic with navigation