Members API Reference

List organization members to resolve emails to user IDs when managing schedules.

Member Methods

client.member.list()

List all members in your organization.

Returns: Promise<OrganizationMember[]>

Example:

const members = await client.member.list();

client.member.listSafe()

List members without throwing exceptions.

Returns: Promise<Result<OrganizationMember[]>>

Example:

const result = await client.member.listSafe();

if (result.error) {
  console.error("Error:", result.error.message);
} else {
  console.log(`Members: ${result.data.length}`);
}

Types

OrganizationMember

type OrganizationMember = {
  userId: string;
  organizationId: string;
  role: string;
  email: string;
};

HTTP Endpoint

List Members

GET /v0/members

Authentication

All API requests require authentication using your API key:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.beeps.dev/v0/members