v1
latestOpenAPI 3.0.32026-08-0613775357.6 KBusers
List users
Lists the accessible account users.
get/users
Query parameters
fieldsstring
A comma-separated list (no spaces) of additional fields to include for each user in the response. Here are the optional values: "tags", "assignments", "availabilities", "custom_field_values", "approvers"
sort_field'created' | 'updated' | 'first_name' | 'last_name' | 'hire_date' | 'termination_date'
A user field on which to sort the users in the response.
sort_order'ascending' | 'descending'
The order for sorting the results based on the sort_field.
with_archivedboolean
If set to true, includes archived users.
include_placeholdersboolean
If set to true, includes placeholder users.
include_countboolean
If set to true, includes the item count in the paging metadata.
per_pageinteger
The maximum number of items to show per response page.
Example:100
pageinteger
The response page to return.
Example:2
Response
The account users.
Example response
{
"paging": {
"per_page": 100,
"page": 1,
"previous": "/api/v1/users?per_page=1000&page=1",
"self": "/api/v1/users?per_page=1000&page=2",
"next": "/api/v1/users?per_page=1000&page=3"
},
"data": [
{
"id": 1234567,
"first_name": "Jane",
"last_name": "Doe",
"display_name": "Jane Doe",
"email": "jane.doe@smartsheet.com",
"billable": true,
"hire_date": "2021-07-09T00:00:00Z",
"guid": "96d769c7-1b4e-4b07-8baf-5ed6f2b915aa",
"role": "Senior",
"discipline": "Program Management",
"location": "Seattle",
"type": "User",
"license_type": "licensed",
"billability_target": 100,
"billrate": -1,
"has_login": true,
"login_type": "smar",
"approver_user_ids": [
123,
456,
789
],
"approvee_user_ids": [
222,
333,
444
],
"last_login_time": "2025-02-17T19:12:36Z",
"created_at": "2024-11-13T20:38:10Z",
"updated_at": "2024-11-13T20:38:10Z"
}
]
}