Return the current workspace user profile.

GET

/api/workspace/auth/me

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/auth/me"),
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/auth/me';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/workspace/auth/me

Locale is resolved from the workspace settings.

Authorizations

None

Parameters

Query Parameters

access_token

string

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

Responses

200

application/json

object

Data

Workspace user profile response.

object

UserId

required

Workspace user identifier.

string

nullable

UserName

required

User login name.

string

nullable

Email

User email address.

string

nullable

FirstName

User first name.

string

nullable

LastName

User last name.

string

nullable

UserType

required

integer format: int32

Allowed values: 0 1 2

WorkspaceName

required

Workspace slug identifier.

string

nullable

Locale

required

Workspace locale code.

string

nullable

TimeZone

required

Workspace time zone identifier.

string

nullable

DateTimeFormat

required

Workspace date-time format pattern.

string

nullable

DateFormat

required

Workspace date format pattern.

string

nullable

TimeFormat

required

Workspace time format pattern.

string

nullable

RegionCode

Workspace routing region code.

string

nullable

OnboardingStatus

required

integer format: int32

Allowed values: 0 1 2

Roles

required

Role names assigned to the user.

Array<string>

nullable

Permissions

required

Permission keys assigned to the user.

Array<string>

nullable

Modules

required

Typed module availability snapshot included in the authenticated user context.

object

Boards