members

List organization members

Returns a collection of members for the given organization.

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

trackable - Whether the user can track time. This is one of 3 values

  • false -- meaning tracking has been explicitly disabled for this user regardless of their role
  • true -- meaning they are allowed to track time
  • viewer -- meaning they are allowed to track time, however as they are only a project viewer (or no memberships) they implicitly can not track on any project

membership_role - The basic role in this organization

  • owner - An owner of the organization. This member can do anything within the organization.
  • manager - An manager of the organization. This member can do anything within the organization except things to do with money. (payroll, invoicing, account billing)
  • user - (By project). A member of the organization where permissions are defined by their project memberships

effective_role - represents an effective role that combines a member's organization role and their project roles

  • organization_owner - The member is an organization owner
  • organization_manager - The member is an organization manager
  • project_manager - The member is an organization user and a manager on all projects and teams
  • project_user - The member is an organization user and a user on all projects and teams
  • project_viewer - The member is an organization user and a viewer on all projects and teams
  • by_project - The member is an organization user and has mixed roles on their projects and team memberships (advanced in the web UI)
  • unassigned - The member has no assigned role and no project memberships (No role in the web UI)

profile - The profile information for the user. Only organization owners and managers may see this information.

  • custom_fields - The custom fields, defined for organization, in format of "key": "value". The meaning of keys is defined in organization.member_profile_fields.

Filtering by dates:

You can filter members by when they were added to the organization 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/organizations/{organization_id}/members

Request

Path parameters

organization_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 organization

include_profileboolean

Include member profile information

include_projectsboolean

Include project memberships for this member

project_statusesstring[]

Filter projects by status when include_projects=true

include_limitsboolean

Include member limits information

membership_rolesstring[]

Search by membership role

invite_link_idinteger

Filter members who joined via the given invite link

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.