Authenticated user, role and accessible workspaces

Minimum role: VIEWER. Active workspace via the X-Workspace-Id header. activeWorkspaceId is null and workspaces is [] when the credential is valid but the user does not have any workspace yet (just registered via POST /auth/signup, before POST /workspaces).

GET/me

Authorization

AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Header parameters

X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses

200

dataMerequired

Show properties

userIdstringrequired

namestringrequired

emailstringrequired

rolestringrequired

DEPRECATED: effective role in the ACTIVE workspace. Use the role of each workspaces row instead. Kept for compatibility with already-published clients.

Allowed:SUPER_ADMINADMINSTAFFVIEWERMINCULTURA

activeWorkspaceIdstring | nullrequired

Show properties

Any of:

string

string

null

null

workspacesWorkspaceAccess[]required

Show properties

Array of WorkspaceAccess

idstringrequired

namestringrequired

slugstringrequired

rolestringrequired

The user's effective role IN THIS workspace.

Allowed:SUPER_ADMINADMINSTAFFVIEWERMINCULTURA

sectionsstring[] | nullrequired

Enabled sections (slugs). null = unrestricted; [] = access expired or revoked.

Show properties

Any of:

string[]

Array of string

string

null

null

401

Missing or invalid credential.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

403

Insufficient role or resource not accessible.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

404

Resource does not exist or is out of scope.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

422

Request body/parameter validation failed.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

X-Workspace-IdheaderActive workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Request

curl -X GET 'https://admin.appfreeticket.com/api/v1/me' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://admin.appfreeticket.com/api/v1/me", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://admin.appfreeticket.com/api/v1/me",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "data": {
    "userId": "string",
    "name": "string",
    "email": "string",
    "role": "SUPER_ADMIN",
    "activeWorkspaceId": "string",
    "workspaces": [
      {
        "id": "string",
        "name": "string",
        "slug": "string",
        "role": "SUPER_ADMIN",
        "sections": [
          "string"
        ]
      }
    ]
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}