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

​
Authentication & Scope

Requires the workspace-users-read ability.

​
Request

GET /workspaces/1/users HTTP/1.1
Host: api.raydocs.com
Authorization: Bearer <token>

​
Path Parameters

ParameterTypeRequiredDescription
workspaceIdintegerYesThe workspace ID

​
Response

200 OK – An array of workspace members. 
[
  {
    "id": 1,
    "name": "John Doe",
    "email": "john@example.com",
    "role": "admin",
    "photo_url": "https://gravatar.com/..."
  },
  {
    "id": 2,
    "name": "Jane Smith",
    "email": "jane@example.com",
    "role": "user",
    "photo_url": "https://gravatar.com/..."
  }
]

​
Role Values

RoleDescription
adminFull access, can manage workspace settings and users
userCan create and edit templates, sessions, and documents
readonlyView-only access to workspace contents

Authorizations

​
Authorization
string
header
required

Personal Access Token

Path Parameters

​
workspaceId
integer
required

Response

Successful

​
id
integer
​
name
string
​
email
string<email>
​
role
enum<string>
Available options:
admin,
user,
readonly