Skip to main content
GET
/
open
/
workspaces
/
{workspaceId}
/
users
List Workspace Users
curl --request GET \
  --url https://api.opnform.com/open/workspaces/{workspaceId}/users \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "name": "<string>",
    "email": "jsmith@example.com",
    "role": "<string>"
  }
]

​
List Workspace Users

Fetch all members of a workspace, including their assigned role.

​
Authentication & Scope

Requires workspace-users-read ability. The requesting user must belong to the workspace.

​
Request

GET /open/workspaces/{workspaceId}/users HTTP/1.1
Host: api.opnform.com
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeDescription
workspaceIdnumberID of the workspace to retrieve.
No query parameters are supported.

​
Response

200 OK – An array of user objects, each including a role field (from the pivot table). 
[
  {
    "id": 3,
    "name": "Alice Porter",
    "email": "alice@example.com",
    "role": "admin"
  },
  {
    "id": 8,
    "name": "Bob Smith",
    "email": "bob@example.com",
    "role": "member"
  }
]
403 Forbidden – Token lacks workspace-users-read or you are not a member.

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
workspaceId
string
required

Response

Successful

​
id
number
​
name
string
​
email
string<email>
​
role
string

Role of the user inside the workspace (admin, member, viewer).