GET
/
v1
/
auth
/
me
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.auth.me()
{
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "roles": [],
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "permissions": []
}

Response

Success

userId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
email
string
required

a string matching the pattern ^[^\s@]+@[^\s@]+.[^\s@]+$

Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
roles
enum<string>[]
required
Available options:
admin,
member,
viewer
organizationId
string<uuid>

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
permissions
enum<string>[]
Available options:
view_organization,
manage_organization,
manage_organization_members,
manage_billing,
manage_team_members,
assign_roles,
create_teams,
delete_teams,
view_workflows,
create_workflows,
edit_workflows,
delete_workflows,
execute_workflows,
view_analytics,
export_analytics,
manage_integrations,
manage_api_keys,
view_assets,
upload_assets,
manage_assets,
delete_assets