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 |
Input Schema (JSON Schema)
{
"properties": {
"companyIds": {
"description": "company ids",
"items": {
"type": "integer"
},
"type": "array"
},
"excludeContacts": {
"description": "exclude contact types, returning only account and collaborator.",
"type": "boolean"
},
"excludeIds": {
"description": "exclude certain user ids",
"items": {
"type": "integer"
},
"type": "array"
},
"excludeProjectIds": {
"description": "exclude people assigned to certain project id",
"items": {
"type": "integer"
},
"type": "array"
},
"fieldsCompanies": {
"description": "Query parameter: fields[companies]",
"items": {
"enum": [
"id",
"name",
"logoUploadedToServer",
"logoImage"
],
"type": "string"
},
"type": "array"
},
"fieldsPeople": {
"description": "Query parameter: fields[people]",
"items": {
"enum": [
"id",
"firstName",
"lastName",
"title",
"email",
"companyId",
"company",
"isAdmin",
"isClientUser",
"isServiceAccount",
"type",
"deleted",
"avatarUrl",
"lengthOfDay",
"workingHoursId",
"workingHour",
"userRate",
"userCost",
"canAddProjects"
],
"type": "string"
},
"type": "array"
},
"fieldsPerson": {
"description": "Query parameter: fields[person]",
"items": {
"enum": [
"id",
"firstName",
"lastName",
"title",
"email",
"companyId",
"company",
"isAdmin",
"isClientUser",
"isServiceAccount",
"type",
"deleted",
"avatarUrl",
"lengthOfDay",
"workingHoursId",
"workingHour",
"userRate",
"userCost",
"canAddProjects"
],
"type": "string"
},
"type": "array"
},
"fieldsProjectPermissions": {
"description": "Query parameter: fields[ProjectPermissions]",
"items": {
"enum": [
"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"
],
"type": "string"
},
"type": "array"
},
"fieldsTeams": {
"description": "Query parameter: fields[teams]",
"items": {
"enum": [
"id",
"name",
"teamLogo",
"teamLogoIcon",
"teamLogoColor"
],
"type": "string"
},
"type": "array"
},
"filterByNoCostRate": {
"description": "Returns users who are missing cost rates(OCA only)",
"type": "boolean"
},
"ids": {
"description": "filter by user ids",
"items": {
"type": "integer"
},
"type": "array"
},
"include": {
"description": "include (not used when generating reports)",
"items": {
"type": "string"
},
"type": "array"
},
"includeClients": {
"description": "include clients",
"type": "boolean"
},
"includeCollaborators": {
"description": "exclude collaborators types, returning only account and contact.",
"type": "boolean"
},
"includePlaceholders": {
"description": "include placeholder users",
"type": "boolean"
},
"includeServiceAccounts": {
"description": "include service accounts",
"type": "boolean"
},
"inclusiveFilter": {
"description": "make the filter inclusive for user ids, teamIds, companyIds",
"type": "boolean"
},
"lastLoginAfter": {
"description": "Query parameter: lastLoginAfter",
"type": "string"
},
"onlyOwnerCompany": {
"description": "return people only from the owner company. This will replace any provided company ID.",
"type": "boolean"
},
"onlySiteOwner": {
"description": "Query parameter: onlySiteOwner",
"type": "boolean"
},
"orderBy": {
"description": "order by",
"enum": [
"name",
"namecaseinsensitive",
"company"
],
"type": "string"
},
"orderMode": {
"description": "order mode",
"enum": [
"asc",
"desc"
],
"type": "string"
},
"orderPrioritiseCurrentUser": {
"description": "Force to have the current/session user in the response",
"type": "boolean"
},
"page": {
"description": "page number (not used when generating reports)",
"type": "integer"
},
"pageSize": {
"description": "number of items in a page (not used when generating reports)",
"type": "integer"
},
"personId": {
"description": "Path parameter: personId",
"type": "integer"
},
"projectId": {
"description": "Path parameter: projectId",
"type": "integer"
},
"projectIds": {
"description": "filter by project ids",
"items": {
"type": "integer"
},
"type": "array"
},
"searchTerm": {
"description": "filter by comment content",
"type": "string"
},
"searchUserJobRole": {
"description": "Include user job role in search",
"type": "boolean"
},
"showDeleted": {
"description": "include deleted items",
"type": "boolean"
},
"skipCounts": {
"description": "SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.",
"type": "boolean"
},
"teamIds": {
"description": "team ids",
"items": {
"type": "integer"
},
"type": "array"
},
"updatedAfter": {
"description": "date time",
"type": "string"
},
"userType": {
"description": "user type",
"enum": [
"account",
"collaborator",
"contact"
],
"type": "string"
}
},
"required": [
"projectId",
"personId"
],
"type": "object"
}