GET/people.json

Get All People

All people visible to the user will be returned, including the user themselves. By default 100 records are returned at a time.

Query Params

  • Name
    projectId
    Type
    integer
    Description
  • Name
    page
    Type
    integer
    Description

    Optionally, you can set the page from which to start retrieving results. This is usually used in conjunction with the parameter pageSize.

    See How does paging work for more detailed documentation on pagination. For example: ?page=2&pageSize=10 will retrieve results 10-20.

  • Name
    pageSize
    Type
    integer
    Description

    The amount of people returned can be limited using this parameter. Normally used in conjunction with the page parameter.

    Minimum: 1

    Default
    100
  • Name
    groupByCompany
    Type
    boolean
    Description
    Default
    false
  • Name
    sort
    Type
    string
    Description

    Sort by a parameter

    Default
    firstName
    Allowed values
    • company
    • logincount
    • lastlogin
    • projectlastactive
    • firstName
    • lastName
    • title
    • dateAdded
  • Name
    sortOrder
    Type
    string
    Description

    asc or desc - The order to sort the returned data

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    fullprofile
    Type
    boolean
    Description
    Default
    false
  • Name
    onlyids
    Type
    boolean
    Description
    Default
    false
  • Name
    getProjectRoles
    Type
    boolean
    Description
    Default
    false
  • Name
    userIds
    Type
    string
    Description
  • Name
    includeTags
    Type
    boolean
    Description
    Default
    false
  • Name
    projectCompanyId
    Type
    integer
    Description
  • Name
    countOnly
    Type
    boolean
    Description
    Default
    false
  • Name
    includeCompanyDetails
    Type
    boolean
    Description
    Default
    false
  • Name
    getCounts
    Type
    boolean
    Description
    Default
    false
  • Name
    includeObservers
    Type
    boolean
    Description
    Default
    true
  • Name
    getWorkingHours
    Type
    string
    Description
  • Name
    updatedAfterDate
    Type
    string
    Description

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 Response

Examples

200 Response

application/json
{
  "STATUS": "OK",
  "people": [
    {
      "permissions": {
        "can-access-templates": false,
        "can-add-projects": false,
        "canManagePortfolio": false,
        "can-manage-people": false,
        "canAccessPortfolio": false
      },
      "avatar-url": "",
      "last-changed-on": "2018-08-09T14:21:19Z",
      "email-address": "",
      "last-login": "",
      "address-country": "",
      "textFormat": "HTML",
      "user-name": "",
      "id": "",
      "phone-number-fax": "",
      "site-owner": false,
      "address-city": "",
      "company-name": "MCG Company",
      "user-invited-date": "",
      "user-type": "collaborator",
      "phone-number-mobile": "",
      "useShorthandDurations": false,
      "address-zip": "",
      "openId": "",
      "address": {
        "city": "",
        "country": "",
        "countrycode": "",
        "zipcode": "",
        "state": "",
        "line1": "",
        "line2": ""
      },
      "phone-number-office": "",
      "im-handle": "",
      "twoFactorAuthEnabled": false,
      "tags": [],
      "has-access-to-new-projects": false,
      "last-active": "",
      "im-service": "",
      "deleted": false,
      "notes": "",
      "in-owner-company": true,
      "user-invited-status": "PENDING",
      "profile": "",
      "userUUID": "",
      "user-invited": "2",
      "created-at": "2018-06-14T14:07:29Z",
      "companyId": "",
      "phone-number-home": "",
      "profile-text": "",
      "company-id": "",
      "pid": "",
      "phone-number-mobile-parts": {
        "countryCode": "",
        "prefix": "",
        "phone": ""
      },
      "address-line-2": "",
      "address-state": "",
      "login-count": "0",
      "address-line-1": "",
      "administrator": false,
      "email-alt-1": "",
      "email-alt-2": "",
      "email-alt-3": "",
      "last-name": "User",
      "title": "",
      "first-name": "Demo 2",
      "phone-number-office-ext": "",
      "twitter": "",
      "lengthOfDay": "8.0"
    }
  ]
}
Download Swagger