Access

Get access permission details for all stages within the specified workflow.

Retrieves the configured access permission details for each stage within the specified workflow. The response includes the assigned role, record visibility scope and edit permission level defined for every workflow stage.

<b>Notes:</b> Record Visibility Scope Values:

  • <b>My Items</b> – User can view only records created by or assigned to them
  • <b>My Team</b> – User can view records belonging to their team
  • <b>All Items</b> – User can view all records within the workflow

Sample request:

Get api/access/test workflow
get/api/Access/{workflowName}

Request

Path parameters

workflowNamestring required

Name of the workflow to retrieve access permissions.

Response

List of stages with access permission details.

stageDisplayNamestring nullable

StageName

rolesstring nullable

Roles

visiblestring nullable

View access value

editstring nullable

access value to edit the workflow

orderNointeger

order no

Changes

No recorded changes to this operation across all 1 revision of this API.