Skip to content
EmailShepherdEmailShepherdDocumentation

List users

GET
/api/v1/users
curl --request GET \
  --url 'https://example.com/%7B%7Bapp_url%7D/api/v1/users?per=10&page=1' \
  --header 'Authorization: Bearer <token>'

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

Media typeapplication/json
object
results
required
Array
object
id
required
integer
first_name
required
string
last_name
required
string
email
required
string format: email
created_at
required
string format: date-time
updated_at
required
string format: date-time
profile_image_url
required
string | null
two_factor_enabled
required
boolean
sso_user
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 guest_comment_on_shared_email
organization_membership
required
object
role_id
required
integer
invitation_sent_at
required
string | null format: date-time
invitation_accepted_at
required
string | null format: date-time
pagination
object
per
required
integer
page
required
integer
total
required
integer
Example
{
  "results": [
    {
      "id": 12345,
      "first_name": "Joe",
      "last_name": "Cottam",
      "email": "joe@example.com",
      "created_at": "2023-08-23T10:30:00.000Z",
      "updated_at": "2023-08-23T10:30:00.000Z",
      "profile_image_url": "https://example.com/profile.jpg",
      "two_factor_enabled": false,
      "sso_user": false,
      "disabled_email_notifications": [
        "mentioned_in_comment"
      ],
      "organization_membership": {
        "role_id": 12345,
        "invitation_sent_at": "2023-08-23T10:30:00.000Z",
        "invitation_accepted_at": "2023-08-23T10:30:00.000Z"
      }
    }
  ],
  "pagination": {
    "per": 10,
    "page": 1,
    "total": 100
  }
}