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

Returns a list of people on a project

Retrieve all people on the project.

Path Params

  • Name
    projectId
    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
    includeServiceAccounts
    Type
    boolean
    Description

    include service accounts

    Default
    false
  • Name
    includeObservers
    Type
    boolean
    Description

    include project observers

    Default
    true
  • 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
    • permissions
  • 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
    MultiResponse contains information about a group of users.
  • 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

MultiResponse
{  "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,
Download Swagger