Get Project Roles for User

GET /public/v1/users/{userId}/project-roles
Api key

Headers

  • X-COMPANY-ID string(uuid) Required

Path parameters

  • userId string(uuid) Required

Responses

  • 500 */*

    Internal Server Error
  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • userId string Required

      The ID of the user

    • projectRoles array[object] Required

      List of project roles for the user

      Details of a user's role within a project

      Hide projectRoles attributes Show projectRoles attributes object
      • projectId integer(int64) Required

        The ID of the project

      • userRoleId string Required

        The ID of the user's direct role in the project

      • groupRoleId string Required

        The ID of the role assigned via the user's group

      • effectiveRoleId string Required

        The effective role ID for the user in the project

      • projectUserId integer(int32) Required

        The ID of the project user record

      • userGroupId string Required

        The ID of the user group

      • userGroupName string Required

        The name of the user group
GET /public/v1/users/{userId}/project-roles 
curl \
 --request GET 'https://live.smartpmtech.com/public/v1/users/{userId}/project-roles' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"
Response examples (500) 
{}
Response examples (200) 
{
  "userId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "projectRoles": [
    {
      "projectId": 12345,
      "userRoleId": "a1b2c3d4-e5f6-7a8b-9c0d-e1f2a3b4c5d6",
      "groupRoleId": "f1e2d3c4-b5a6-7d8e-9f0a-b1c2d3e4f5a6",
      "effectiveRoleId": "123e4567-e89b-12d3-a456-426614174000",
      "projectUserId": 67890,
      "userGroupId": "0f1e2d3c-4b5a-6d7e-8f9a-0b1c2d3e4f5a",
      "userGroupName": "Project Managers"
    }
  ]
}