Path parameters

• projectId string Required

  The project's unique document ID.

• personId string Required

  The project's person unique document ID, i.e. project.people[].person._id.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • _id string(ObjectId)

    The unique document ID.

  • permission string

    Determines the person's permissions within the project. A member can do basic work on the project, a manager has additional control over the project, like managing basic settings, project duration, people rates, etc. and an admin has full control over the project. The observer can view everything, but not change anything.

    Values are member, manager, admin, or observer.

  • person object
    Hide person attributes Show person attributes object

    • _id string(ObjectId)

      The unique document ID.

    • firstName string

      The person's first name.

    • lastName string

      The person's last name.

    • avatar string

      The person's profile picture.

    • city string

      The person's residing city.

    • country string

      The person's residing country.

    • state string

      The person's residing state.

    • timezone string

      The person's timezone in the IANA time zone database format, e.g. America/Toronto.

  • role string

    Reference to an org role, i.e. org.roles[]._id

  • roleTitle string

    The title of the role. E.g. Director of Sales

  • email string(email)

    The person's email in the project.

  • isProjectManager boolean

    If true, this person can act as a project manager. A project manager can assign resources to roles, approve leave requests, etc.

    Default value is false.

  • rate number(float)

    The person's charge rate.

    Minimum value is 0.

  • rateTime string

    The person's charge rate time.

    Values are oneTime, recurring, hourly, daily, weekly, monthly, or yearly.

  • invitePendingSince number(integer)

    The timestamp the person was invited to the project. If this field is defined, it means that the invitation is still pending.

  • praise number(integer)

    The number of praises this person has received.

    Minimum value is 0.

• 400 application/json

  Bad Request

  Hide response attributes Show response attributes object

  • message string

    An error message.

  • code string

    An error code to handle specific error responses.

  • data object

    Optionally, additional data to help handle the error.

    Additional properties are allowed.

• 500 application/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • message string

    An error message.

  • code string

    An error code to handle specific error responses.

  • data object

    Optionally, additional data to help handle the error.

    Additional properties are allowed.