Skip to content
MoltaroMoltaroMoltaro Docs

Return the authenticated workspace user's profile.

GET
/api/workspace/account/profile
curl --request GET \
  --url https://example.com/api/workspace/account/profile

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Profile fields for the authenticated workspace account.

object
UserId

Workspace user identifier.

string
nullable
UserName

Exact stored Unicode login name.

string
nullable
Email

Optional email address.

string
nullable
FirstName

First name.

string
nullable
LastName

Last name.

string
nullable
DisplayName

Canonical effective display name.

string
nullable
UserType
integer format: int32
Allowed values: 0 1 2
Avatar

Avatar presentation values for a workspace user.

object
Initials

Initials derived from the user name.

string
nullable
BackgroundColor

Hex color for the avatar background.

string
nullable
TextColor

Hex color for the avatar text.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "UserType": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data

Profile fields for the authenticated workspace account.

object
UserId

Workspace user identifier.

string
nullable
UserName

Exact stored Unicode login name.

string
nullable
Email

Optional email address.

string
nullable
FirstName

First name.

string
nullable
LastName

Last name.

string
nullable
DisplayName

Canonical effective display name.

string
nullable
UserType
integer format: int32
Allowed values: 0 1 2
Avatar

Avatar presentation values for a workspace user.

object
Initials

Initials derived from the user name.

string
nullable
BackgroundColor

Hex color for the avatar background.

string
nullable
TextColor

Hex color for the avatar text.

string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "UserType": 0
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}