Stakeholders data

<< Click to Display Table of Contents >>

Navigation:  Application integration > Bizagi RESTful API > Bizagi API examples > Data services examples >

Stakeholders data


Bizagi features an OData service which handles aspects of the Experience design, as described at Data services.

Through the Stakeholders URI, you can handle data related to Stakeholders in the project.


Resource URL

Start with the following URL:




[your_bizagi_project_url]: The URL where end users access the Bizagi Work Portal.

For an on-premises Bizagi project, the URL would be:


For Automation Service projects, the URL would be:




The following image illustrates how you can send an HTTP GET for this resource:




Returned results include (inside the value element):

Name: The unique name of the Stakeholder, as defined in Bizagi Studio.

DisplayName: The default display name of the Stakeholder, as shown to end users in the Work Portal. The unique URL to access the Stakeholder.

Id: A string-based GUID representing the URI of the Stakeholder.

IconName: The name of the icon used to represent the Stakeholder.



Every set of results returned by the OData services includes a set of standard properties which are preceded by the @ sign. These properties are described at Properties and querying options.