Stakeholders metadata

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData RESTful services > Bizagi API examples > Metadata services examples >

Stakeholders metadata


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

Through the Stakeholders URI, you may handle metadata 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 an on-premises Bizagi project, the URL would be:


For Automation Service projects, the URL would be:




This resource is available through an HTTP GET action.



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.


Through the property, you can obtain a specific record's details only, instead of a full list.

For example, use:





You can navigate to and explore specific elements of a given Stakeholder, such as the My Stuff collections, Searches, or Relevant processes.

For more information about how to navigate to My Stuff, refer to Stakeholder's My Stuff metadata.

For more information about how to navigate to Searches, refer to Stakeholder's Searches metadata.

For more information about how to navigate to Relevant processes, refer to Stakeholder's Relevant processes metadata.