Skip to content
Documentation

List Workspace Users

GET
/api/v1/workspaces/{workspace_id}/users

Retrieves the users for a workspace.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
results
required
Array<object>
object
id
required
integer
Example
12345
first_name
required
string
Example
Joe
last_name
required
string
Example
Cottam
email
required
string format: email
Example
[email protected]
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
profile_image_url
required
string format: url
nullable
Example
https://example.com/profile.jpg
wants_marketing_emails
required
boolean
two_factor_enabled
required
boolean
disabled_email_notifications
required
Array<string>
Allowed values: mentioned_in_comment reply_in_comment_thread requested_review review_changes_requested review_approved ready_to_publish
pagination
required
object
per
required
integer
Example
10
page
required
integer
Example
1
total
required
integer
Example
100

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

404

Section titled “404 ”

Not Found

object
message
required
string
Example
Record not found