Skip to content
Documentation

List users

GET
/api/v1/users

Retrieves the users.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

search
string

Filter users by search term

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
results
required
Array
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
organization_membership
required
object
role_id
required
integer
Example
12345
invitation_sent_at
required
string format: date-time
nullable
Example
2023-08-23T10:30:00.000Z
invitation_accepted_at
required
string format: date-time
nullable
Example
2023-08-23T10:30:00.000Z
pagination
required
object
per
required
integer
Example
10
page
required
integer
Example
1
total
required
integer
Example
100