getProjectPerson
Retrieve detailed records of individuals associated with a specific project, filtering by user type, role, or activity, to manage team participation effectively.
Instructions
Returns one or more people on a project. Retrieve a person(s) record.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
companyIds | No | company ids | |
excludeContacts | No | exclude contact types, returning only account and collaborator. | |
excludeIds | No | exclude certain user ids | |
excludeProjectIds | No | exclude people assigned to certain project id | |
fieldsCompanies | No | Query parameter: fields[companies] | |
fieldsPeople | No | Query parameter: fields[people] | |
fieldsPerson | No | Query parameter: fields[person] | |
fieldsProjectPermissions | No | Query parameter: fields[ProjectPermissions] | |
fieldsTeams | No | Query parameter: fields[teams] | |
filterByNoCostRate | No | Returns users who are missing cost rates(OCA only) | |
ids | No | filter by user ids | |
include | No | include (not used when generating reports) | |
includeClients | No | include clients | |
includeCollaborators | No | exclude collaborators types, returning only account and contact. | |
includePlaceholders | No | include placeholder users | |
includeServiceAccounts | No | include service accounts | |
inclusiveFilter | No | make the filter inclusive for user ids, teamIds, companyIds | |
lastLoginAfter | No | Query parameter: lastLoginAfter | |
onlyOwnerCompany | No | return people only from the owner company. This will replace any provided company ID. | |
onlySiteOwner | No | Query parameter: onlySiteOwner | |
orderBy | No | order by | |
orderMode | No | order mode | |
orderPrioritiseCurrentUser | No | Force to have the current/session user in the response | |
page | No | page number (not used when generating reports) | |
pageSize | No | number of items in a page (not used when generating reports) | |
personId | Yes | Path parameter: personId | |
projectId | Yes | Path parameter: projectId | |
projectIds | No | filter by project ids | |
searchTerm | No | filter by comment content | |
searchUserJobRole | No | Include user job role in search | |
showDeleted | No | include deleted items | |
skipCounts | No | SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons. | |
teamIds | No | team ids | |
updatedAfter | No | date time | |
userType | No | user type |