Skip to content

Role Page — role description, team, reporting line.

GET
/users/{userId}/role
curl --request GET \
--url https://api.gospl.example/v1/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/role \
--header 'Authorization: Bearer <token>'
userId
required
string format: uuid

OK

Media type application/json

FR-20/22 — minimal role data only.

object
user
required
object
id
required
string format: uuid
name
required
string
jobTitle
string
team
string
roleDescription
required
string
reportsTo
required
One of:
object
id
required
string format: uuid
name
required
string
jobTitle
string
team
string
Example generated
{
"user": {
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"jobTitle": "example",
"team": "example"
},
"roleDescription": "example",
"reportsTo": {
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"name": "example",
"jobTitle": "example",
"team": "example"
}
}

Missing/invalid credentials.

Media type application/json
object
code
required
string
message
required
string
Example generated
{
"code": "example",
"message": "example"
}

Not found within the caller’s tenant.

Media type application/json
object
code
required
string
message
required
string
Example generated
{
"code": "example",
"message": "example"
}