Skip to Content
DocumentationAdmin Back-officeAPI ReferenceMember API

Member API

⚡ 5 min read

The transcodes.member object provides methods to retrieve member (end-user) profile data from the server

Methods

get()

Retrieves member information from the server

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

Parameters:

ParameterTypeRequiredDescription
projectIdstringNoProject ID
memberIdstringNoMember ID to fetch
emailstringNoEmail address to search
fieldsstringNoComma-separated fields to return

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;
  metadata?: Record<string, string | number | boolean | null | undefined>;
  createdAt?: Date | string;
  updatedAt?: Date | string;
}

ApiResponse<T>

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

Usage Examples

Fetch member after login

async function handleLogin() {
  const result = await transcodes.openAuthLoginModal({
    projectId: 'proj_xxx',
  });
 
  if (result.success) {
    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);
    }
  }
}
Last updated on
Token APIEvents API