GET/projects/api/v3/me.json

Get logged user information

Query Params

  • Name
    userId
    Type
    integer
    Description

    filter by user

  • Name
    includeAuth
    Type
    boolean
    Description

    include users auth information

  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • projects
    • users
  • Name
    fields[users]
    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[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • 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

Responses

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

Examples

200 OK

Response
{
  "person": {
    "administrator": true,
    "auth": {
      "timestamp": "string",
      "token": "string",
      "userType": "string"
    },
    "avatarUrl": "string",
    "canAccessPortfolio": true,
    "canAddProjects": true,
    "canManagePortfolio": true,
    "company": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "companyId": 0,
    "companyRoleId": 0,
    "createdAt": "string",
    "createdBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "deleted": true,
    "email": "string",
    "emailAddress": "string",
    "firstName": "string",
    "id": 0,
    "inOwnerCompany": true,
    "installationId": 0,
    "isAdmin": true,
    "isClientUser": true,
    "isPlaceholderResource": true,
    "isServiceAccount": true,
    "jobRoles": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "lastLogin": "string",
    "lastName": "string",
    "ldHash": "string",
    "lengthOfDay": 0,
    "meta": {},
    "phoneNumberMobile": "string",
    "siteOwner": true,
    "skills": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "teams": [
      {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    ],
    "timezone": "string",
    "title": "string",
    "type": "string",
    "updatedAt": "string",
    "updatedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "userCost": 0,
    "userName": "string",
    "userRate": 0,
    "userRates": {
      "additionalProp": {
        "amount": 0,
        "currency": {
          "id": 0,
          "meta": {},
          "type": "string"
        }
      }
    },
    "userType": "string",
    "workingHour": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "workingHoursId": 0
  }
}
Download Swagger