Member API

⚡ 5 min read

The transcodes.member object provides methods to retrieve member (end-user) profile data from the server (GET /auth/member, cookie credentials). Only get() is exposed on window.transcodes.member — list/create/update/delete are Console/MCP admin APIs, not the host SDK.

Methods

get()

Retrieves member information from the server


transcodes.member.get(params: {
  projectId?: string;
  memberId?: string;
  email?: string;
  fields?: string;
}): Promise<ApiResponse<Member[]>>

Parameters:

Parameter	Type	Required	Description
`projectId`	`string`	No	Project ID
`memberId`	`string`	No	Member ID to fetch
`email`	`string`	No	Email address to search
`fields`	`string`	No	Comma-separated fields to return. Default: `id,projectId,name,email,metadata,role`

Returns: Promise<ApiResponse<Member[]>>

Example - Get member by ID:


const result = await transcodes.member.get({
  projectId: 'proj_xxx',
  memberId: 'mbr_xxx',
});
 
if (result.success) {
  const member = result.payload[0];
  console.log('Member:', member.name, member.email);
} else {
  console.error('Failed to get member:', result.error);
}

Example - Get member by email:


const result = await transcodes.member.get({
  projectId: 'proj_xxx',
  email: 'member@example.com',
});
 
if (result.success && result.payload.length > 0) {
  const member = result.payload[0];
  console.log('Found member:', member.id);
}

Example - Get specific fields:


const result = await transcodes.member.get({
  projectId: 'proj_xxx',
  memberId: 'mbr_xxx',
  fields: 'id,email,name',
});

Type Definitions

Member


interface Member {
  id: string;
  projectId?: string;
  name?: string;
  email?: string;
  role?: string;
  createdAt?: Date | string;
  updatedAt?: Date | string;
}

Server responses can include metadata when requested via fields, but the shipped Member type in transcodes.d.ts does not include it — see Types.

ApiResponse<T>


interface ApiResponse<T> {
  success: boolean;
  payload: T;
  error?: string;
  message?: string;
  status?: number;
}

Usage Examples


async function afterSignIn() {
  const result = await transcodes.handleSignInCallback();
  if (!result?.success) return;
 
  const memberId = result.payload[0].member.id;
 
  const memberResult = await transcodes.member.get({
    projectId: 'proj_xxx',
    memberId,
  });
 
  if (memberResult.success) {
    const member = memberResult.payload[0];
    console.log('Welcome,', member?.name || member?.email);
  }
}

Token API - Authentication tokens
Redirect API - Sign-in redirects
Events API - Auth state change events
Types - Type definitions