Skip to content

Get User Profile

GET
/api/canvas/{deal_id}/users/{user_id}
curl --request GET \
--url https://example.com/api/canvas/example/users/example \
--header 'Authorization: Bearer <token>'

Get a single user profile by Slack user ID.

Security note (CWE-200 accepted risk): Returns only non-sensitive display data (user_id, display_name, avatar_url — no email/PII). Scoped to RequireViewer (caller must have deal access).

deal_id
required
Deal Id
string
user_id
required
User Id
string

Successful Response

Media type application/json
UserProfileResponse
object
user_id
required
User Id
string
display_name
required
Display Name
string
avatar_url
Avatar Url
string
""
Example
{
"avatar_url": ""
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}