Skip to main content
GET
Get All Users

Authorizations

X-Api-Key
string
header
required

Query Parameters

query
string

Filter users by name or email.

limit
integer

Maximum number of users to return.

Response

OK

id
number
required
Example:

1304

email
string
required
Example:

"john.bender@example.com"

name
string
required
Example:

"John Bender"

role
enum<string>
required
Available options:
admin,
supervisor,
member,
member_limited
Example:

"admin"

status
enum<string>
required
Available options:
active,
invited,
pending,
removed
Example:

"active"

type
enum<string>
required
Available options:
employee,
contractor
Example:

"employee"

createdAt
string
required

Format: Y-m-d H:i:s

Example:

"2016-08-13 15:27:30"

isEmailVerified
boolean
required
Example:

true

groups
object[]
required

Groups the member belongs to. Empty array when the member is in no group.

permissions
object
required

Areas the user can access beyond the base role. A key is present only when the user has access to that area. Users with no elevated access return an empty array ([]) instead of an object — treat both as "no permissions".

timeTrackingPolicy
object
required

Time tracking rules that apply to the user. Team defaults unless the team overrides them for this member.

favorite
boolean
required

Whether you marked this member as a favorite.

Example:

false

headline
string | null

Job title. Empty string when not set.

Example:

"CEO"

phone
string

Omitted when not set.

Example:

"+1 555 0100"

externalId
string

Employee ID from your own system, set on the member profile. Omitted when not set.

Example:

"M-3490"

avatarUrl
string | null

Omitted when the member has no avatar.

Example:

"https://d36887svjhykt4.cloudfront.net/users/1304-15ea197d07ca81.jpg"

avatarUrlLarge
string | null

Omitted when the member has no avatar.

Example:

"https://d36887svjhykt4.cloudfront.net/users/1304-15ea197d10830c.jpg"

capacity
integer | null

Weekly capacity in seconds.

Example:

144000

cost
integer

Hourly cost in cents. Returns 0 when you lack the costs permission.

Example:

2500

costHistory
array | null

Past hourly cost values. null when the member has no cost history or you lack the costs permission.

Example:

null

resourcePlannerAccess
object

Resource planner access flags. Returned for the authenticated user.