Stakeholders data

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Services index > Data services >

Stakeholders data


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

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


Resource URL

Start off from the following URL:




[your_bizagi_project_url]: Corresponds to the URL where end users access the Bizagi Work portal.

For instance for an on-premise Bizagi project, such URL would be:


While for Bizagi PaaS projects, such URL would be:




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




Returned results consider (inside of 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 that specific Stakeholder.

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

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



In addition to the above, for every set of results returned by the OData services, the successful response includes a set of standard properties which are preceded by the @ sign. Such properties are described at Properties and querying options.