GET/projects/api/v3/people/{personId}.json

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
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
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
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
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
teamIds
Type
array[integer]
Description
team ids
Format
Comma separated values
Name
projectIds
Type
array[integer]
Description
filter by project ids
Format
Comma separated values
Name
include
Type
array[string]
Description
include (not used when generating reports)
Format
Comma separated values
Allowed values
- companies
- workingHours
Name
ids
Type
array[integer]
Description
filter by user ids
Format
Comma separated values
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
companyIds
Type
array[integer]
Description
company ids
Format
Comma separated values

Responses

Code
200
Type
object
Schema
Description
200 OK
Response contains information about a user.
Code
400
Type
object
Schema
Description
400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
Code
403
Type
object
Schema
Description
403 Forbidden
ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

Response

{
  "included": {
    "ProjectPermissions": {
      "additionalProp": {
        "active": true,
        "addExpenses": true,
        "addFiles": true,
        "addForms": true,
        "addLinks": true,
        "addMessages": true,
        "addMilestones": true,
        "addNotebooks": true,
        "addProjectUpdate": true,
        "addRisks": true,
        "addTaskLists": true,
        "addTasks": true,
        "addTime": true,
        "canAccess": true,
        "canEditWorkflows": true,
        "canManagePeople": true,
        "canManageProjectBudget": true,
        "canManageProjectMembership": true,
        "canManageProjectTemplates": true,
        "canManageRates": true,
        "canManageSchedule": true,
        "canViewForms": true,
        "canViewProjectBudget": true,
        "canViewProjectMembers": true,
        "canViewProjectTemplates": true,
        "canViewRates": true,
        "canViewSchedule": true,
        "canViewWorkflows": true,
        "editAllTasks": true,
        "inOwnerCompany": true,
        "isArchived": true,
        "isObserving": true,
        "manageCustomFields": true,
        "projectAdministrator": true,
        "receiveEmailNotifications": true,
        "setPrivacy": true,
        "viewAllTimeLogs": true,
        "viewEstimatedTime": true,
        "viewInvoices": true,
        "viewLinks": true,
        "viewMessagesAndFiles": true,
        "viewNotebooks": true,
        "viewProjectUpdate": true,
        "viewRiskRegister": true,
        "viewTasksAndMilestones": true,
        "viewTime": true
      }
    },
    "companies": {
      "additionalProp": {
        "accounts": 0,
        "addressOne": "string",
        "addressTwo": "string",
        "budgetDistribution": [
          {
            "color": "string",
            "companyId": 0,
            "count": 0,
            "from": 0,
            "to": 0
          }
        ],
        "canSeePrivate": true,
        "cid": "string",
        "city": "string",
        "clientManagedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "clients": 0,
        "collaborators": 0,
        "companyDomains": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "companyNameUrl": "string",
        "companyUpdate": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "contacts": 0,
        "countryCode": "string",
        "createdAt": "string",
        "emailOne": "string",
        "emailThree": "string",
        "emailTwo": "string",
        "fax": "string",
        "financialBudgetSummary": {
          "totalCapacity": 0,
          "totalCapacityUsed": 0
        },
        "id": 0,
        "industry": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "industryId": 0,
        "isOwner": true,
        "logoUrl": "string",
        "name": "string",
        "phone": "string",
        "privateNotes": "string",
        "privateNotesText": "string",
        "profileText": "string",
        "profitability": {
          "billable": 0,
          "billableTime": 0,
          "companyCount": 0,
          "cost": 0,
          "expenses": 0,
          "loggedTime": 0,
          "nonBillableTime": 0,
          "ownerCount": 0,
          "profit": 0
        },
        "state": "string",
        "stats": {
          "projectCount": 0,
          "taskCompleteCount": 0,
          "taskCount": 0,
          "unreadEmailCount": 0
        },
        "status": "string",
        "tags": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "timeBudgetSummary": {
          "totalCapacity": 0,
          "totalCapacityUsed": 0
        },
        "updatedAt": "string",
        "website": "string",
        "zip": "string"
      }
    },
    "jobRoles": {
      "additionalProp": {
        "createdAt": "string",
        "createdByUser": 0,
        "deletedAt": "string",
        "deletedByUser": 0,
        "id": 0,
        "isActive": true,
        "name": "string",
        "primaryUsers": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "updatedAt": "string",
        "updatedByUser": 0,
        "users": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ]
      }
    },
    "teams": {
      "additionalProp": {
        "company": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "createdAt": "string",
        "createdBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "id": 0,
        "name": "string",
        "teamLogo": "string",
        "teamLogoColor": "string",
        "teamLogoIcon": "string",
        "updatedAt": "string",
        "updatedBy": {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      }
    },
    "workingHours": {
      "additionalProp": {
        "createdAt": "string",
        "dateCreated": "string",
        "dateUpdated": "string",
        "description": "string",
        "entries": [
          {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        ],
        "entryIds": [
          0
        ],
        "id": 0,
        "name": "string",
        "object": {
          "id": 0,
          "meta": {},
          "type": "string"
        },
        "objectId": 0,
        "objectType": "string",
        "updatedAt": "string"
      }
    }
  },
  "person": {
    "avatarUrl": "string",
    "canAddProjects": true,
    "company": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "companyId": 0,
    "companyRoleId": 0,
    "createdAt": "string",
    "createdBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "deleted": true,
    "email": "string",
    "firstName": "string",
    "id": 0,
    "isAdmin": true,
    "isClientUser": true,
    "isPlaceholderResource": true,
    "isServiceAccount": true,
    "jobRoles": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "lastName": "string",
    "lengthOfDay": 0,
    "meta": {},
    "teams": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "timezone": "string",
    "title": "string",
    "type": "string",
    "updatedAt": "string",
    "updatedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "userCost": 0,
    "userRate": 0,
    "workingHour": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "workingHoursId": 0
  }
}

Download Swagger