members

List project members

Returns a collection of members for the given project.

Results can be filtered by search, user IDs, membership role, and date range.

membership_role - The permission role the member has in this project

  • manager - An manager can track time, see data for any member within the project, can change settings, and manage membership within the project
  • user - A user can track time against the project and see only their own data within the project
  • viewer - A viewer can access reports based on data for any member within the project but can not change anything

Note: A member must have membership within a project in order to track on that project, even if they are an organization owner or manager

Filtering by dates:

You can filter members by when they were added to the project using the created_at parameter:

  • Use created_at[start] to get members added on or after a specific date
  • Use created_at[stop] to get members added before a specific date
  • Use both to get members added within a date range

You can also filter by when membership was last updated using the updated_at parameter:

  • Use updated_at[start] to get members updated on or after a specific date
  • Use updated_at[stop] to get members updated before a specific date
  • Use both to get members updated within a date range
get/v2/projects/{project_id}/members

Request

Path parameters

project_idinteger required

Query parameters

page_start_idinteger

The page start ID.

page_limitinteger

The default page size

search[email]string

An email to search for members

search[name]string

A name to search for members

include_removedboolean

Include members that were removed from the project

include_profileboolean

Include member profile information

direct_onlyboolean

If true, only include members assigned directly to the project and not as member of a team working on the project

membership_rolesstring[]

Search by membership role

created_at[start]string date-time

Start date for created_at filter (inclusive)

created_at[stop]string date-time

End date for created_at filter (exclusive)

updated_at[start]string date-time

Start date for updated_at filter (inclusive)

updated_at[stop]string date-time

End date for updated_at filter (exclusive)

user_idsinteger[]

List of user IDs

includestring[]

Specify related data to side load.

Response

A list of members

Changes

No recorded changes to this operation across all 1 revision of this API.