v1

latestOpenAPI 3.0.32026-08-0613775357.6 KB
users per project

List project users

Retrieves a list of users associated with a specific project.

Note: Users are associated with a project via Assignments.

get/projects/{project_id}/users

Path parameters

project_idinteger required

The ID of the project.

Query parameters

per_pageinteger

Parameters for pagination.

pageinteger

Parameters for pagination.

fields'tags' | 'assignments' | 'availabilities' | 'custom_field_values'

A comma-separated list of additional fields to include in the response.

sort_field'created' | 'updated' | 'first_name' | 'last_name' | 'hire_date' | 'termination_date'

Field to sort the return document.

sort_order'ascending' | 'descending'

Order to sort the results on.

with_phasesboolean

If set to true, includes users who are assigned to phases (child projects).

with_archivedboolean

If set to true, includes archived users.

include_placeholdersboolean

If set to true, includes placeholder users.

Response

A paginated list of users for the project.

Example response

{
  "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"
    }
  ],
  "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"
  }
}