Returns a person

Retrieve a person record.

Path Params

Name
personId
Type
integer
required
Description

Query Params

Name
userType
Type
string
Description
user type
Allowed values
- account
- collaborator
- contact
Name
updatedAfter
Type
string
Description
date time
Name
searchTerm
Type
string
Description
filter by comment content
Name
orderMode
Type
string
Description
order mode
Default
asc
Allowed values
- asc
- desc
Name
orderBy
Type
string
Description
order by
Default
name
Allowed values
- name
- namecaseinsensitive
- company
- id
Name
lastLoginAfter
Type
string
Description
Name
pageSize
Type
integer
Description
number of items in a page (not used when generating reports)
Default
50
Name
page
Type
integer
Description
page number (not used when generating reports)
Default
1
Name
skipCounts
Type
boolean
Description
SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.
Name
showDeleted
Type
boolean
Description
include deleted items
Default
false
Name
searchUserSkill
Type
boolean
Description
Include user skills in search
Name
searchUserJobRole
Type
boolean
Description
Include user job role in search
Name
orderPrioritiseCurrentUser
Type
boolean
Description
Force to have the current/session user in the response
Name
onlySiteOwner
Type
boolean
Description
Default
false
Name
onlyPlaceholders
Type
boolean
Description
return only placeholder users
Default
false
Name
onlyOwnerCompany
Type
boolean
Description
return people only from the owner company. This will replace any provided company ID.
Default
false
Name
inclusiveFilter
Type
boolean
Description
make the filter inclusive for user ids, teamIds, companyIds
Default
false
Name
includeStandardUsers
Type
boolean
Description
include standard users; false removes non-client account users so e.g. only contacts can be asked for
Default
true
Name
includeServiceAccounts
Type
boolean
Description
include service accounts
Default
false
Name
includePlaceholders
Type
boolean
Description
include placeholder users
Default
false
Name
includeCollaborators
Type
boolean
Description
exclude collaborators types, returning only account and contact.
Default
true
Name
includeClients
Type
boolean
Description
include clients
Default
true
Name
filterByNoCostRate
Type
boolean
Description
Returns users who are missing cost rates(OCA only)
Name
excludeContacts
Type
boolean
Description
exclude contact types, returning only account and collaborator.
Default
false
Name
clientPortalEligible
Type
boolean
Description
only include people who can be added to a client portal
Default
false
Name
adminsOnly
Type
boolean
Description
only include users with administrator status in the response
Default
false
Name
teamIds
Type
array[integer]
Description
team ids
Format
Comma separated values
Name
skillIds
Type
array[integer]
Description
filter by skill ids
Format
Comma separated values
Name
projectIds
Type
array[integer]
Description
filter by project ids
Format
Comma separated values
Name
projectCompanyIds
Type
array[integer]
Description
filter by project company ids
Format
Comma separated values
Name
notLinkedWithClientPortalIds
Type
array[integer]
Description
exclude people already on the given client portals, leaving the ones that can still be added to them
Format
Comma separated values
Name
jobRoleIds
Type
array[integer]
Description
filter by job role ids
Format
Comma separated values
Name
include
Type
array[string]
Description
include (not used when generating reports). currencies is only populated for administrators of the owner company

skills side loads the skills each person holds; with the skill levels feature on, every skill relationship also carries a meta.level holding the level that person holds for it, and null where they hold the skill but are not yet rated.

linkedClientPortalCompanies resolves each person's own company against one client portal and needs exactly one notLinkedWithClientPortalIds, otherwise the request is rejected
Format
Comma separated values
Allowed values
- companies
- workingHours
- currencies
- teams
- jobRoles
- skills
- linkedClientPortalCompanies
Name
ids
Type
array[integer]
Description
filter by user ids
Format
Comma separated values
Name
fields[userIntegrations]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- userId
- projectId
- canAccessBox
- canAccessDropbox
- canAccessGoogleDocs
- canAccessOneDrive
- canAccessOneDriveBusiness
- canAccessSharePoint
Name
fields[teams]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- teamLogo
- teamLogoIcon
- teamLogoColor
Name
fields[person]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
Name
fields[people]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- firstName
- lastName
- title
- email
- companyId
- company
- isAdmin
- isClientUser
- isServiceAccount
- type
- deleted
- avatarUrl
- lengthOfDay
- workingHoursId
- workingHour
- userRate
- userCost
- canAddProjects
Name
fields[companies]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- id
- name
- logoUploadedToServer
- logoImage
Name
fields[ProjectPermissions]
Type
array[string]
Description
Format
Comma separated values
Allowed values
- viewMessagesAndFiles
- viewTasksAndMilestones
- viewTime
- viewNotebooks
- viewRiskRegister
- viewEstimatedTime
- viewInvoices
- addTasks
- addRisks
- manageCustomFields
- addExpenses
- editAllTasks
- addMilestones
- addTaskLists
- addMessages
- addFiles
- addTime
- addNotebooks
- viewLinks
- addLinks
- canViewForms
- addForms
- viewAllTimeLogs
- setPrivacy
- projectAdministrator
- viewProjectUpdate
- addProjectUpdate
- canViewProjectMembers
- canViewProjectBudget
- canManageProjectBudget
- canViewRates
- canManageRates
- canViewSchedule
- canManageSchedule
- receiveEmailNotifications
- isObserving
- isArchived
- active
- canAccess
- inOwnerCompany
- canManagePeople
- canViewProjectTemplates
- canManageProjectTemplates
Name
excludeProjectIds
Type
array[integer]
Description
exclude people assigned to certain project id
Format
Comma separated values
Name
excludeIds
Type
array[integer]
Description
exclude certain user ids
Format
Comma separated values
Name
excludeAllocatedUsersProjectIDs
Type
array[integer]
Description
exclude people who have a non-deleted allocation for the given project ids
Format
Comma separated values
Name
emails
Type
array[string]
Description
filter by user emails
Format
Comma separated values
Name
companyIds
Type
array[integer]
Description
company ids
Format
Comma separated values
Name
SkillLevels
Type
array[string]
Description
Not a literal parameter name; pass one or more skill[<skillId>]=<level> keys. Filter by skill and level - e.g. skill[7]=3&skill[9]= for skill 7 at level 3 and skill 9 at any level. An empty value matches any level, including unrated. Several of them combine as a strict AND.
Format
Comma separated values

Path Params

Query Params

Responses

Examples

200 OK