---
title: "Get access permission details for all stages within the specified workflow."
method: GET
path: "/api/Access/{workflowName}"
tags: ["Access"]
---

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

`GET /api/Access/{workflowName}`

## Request

- Base URL: `https://apidocs.cflowapps.com` (the document declares no server; this is the origin it was published from)
- URL: `https://apidocs.cflowapps.com/api/Access/{workflowName}`
- Auth: API key in header `X-Api-Key` and API key in header `X-User-Key`
- TypeScript: <https://skmtc.dev/cflowapps/apis/cflow-public-api/docs/api/Access/:workflowName/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `workflowName` string, required

## Response `200`

List of stages with access permission details.

- AccessPermissionResDto[]
  - `stageDisplayName` string, nullable: StageName
  - `roles` string, nullable: Roles
  - `visible` string, nullable: View access value
  - `edit` string, nullable: access value to edit the workflow
  - `orderNo` integer: order no

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Workflow not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/cflowapps/apis/cflow-public-api.md) - [All operations](https://skmtc.dev/cflowapps/apis/cflow-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cflowapps/apis/cflow-public-api/revisions/af0dadd0ad10?raw)