GET
/
api
/
v3
/
users
curl --request GET \
  --url https://app-sandbox.staging.sendo.so/api/v3/users \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 1,
  "per_page": 5,
  "total_users": 20,
  "users": [
    {
        "id": 12345,
        "first_name": "Sendoso",
        "last_name": "Devs",
        "email": "developers@sendoso.com",
        "team_group_id": 6789
    }
  ]
}

​
Parameters

​
page
integer

The page number of the results you want to retrieve (the first page is 1). See Pagination for more information.

​
per_page
integer

The number of users to be returned per page (max is 100). See Pagination for more information.

​
Response

​
current_page
integer
required

The current page being returned (used for pagination purposes).

​
per_page
integer
required

The number of results being returned per page (used for pagination purposes).

​
total_users
integer
required

The total number of users (used for pagination purposes).

​
users
array
required

List of user objects

​
id
string
required

The user’s identifier

​
first_name
string
required

The user’s first name

​
last_name
string
required

The user’s last name

​
email
string
required

The user’s email

​
team_group_id
number
required

The user’s team group id

{
  "current_page": 1,
  "per_page": 5,
  "total_users": 20,
  "users": [
    {
        "id": 12345,
        "first_name": "Sendoso",
        "last_name": "Devs",
        "email": "developers@sendoso.com",
        "team_group_id": 6789
    }
  ]
}
Previous
Invite New User
Next