@archastro/sdk
    Preparing search index...

    Interface TeamMembership

    A record representing a user's or agent's membership in a team, including their resolved identity details and role.

    interface TeamMembership {
        agent?: Agent;
        created_at?: string;
        id: string;
        joined_at?: string;
        metadata?: Record<string, unknown>;
        name?: string;
        profile_picture?: ImageSource;
        role?: string;
        team?: Record<string, unknown>;
        type?: string;
        updated_at?: string;
        user?: User;
    }
    Index

    Properties

    agent? created_at? id joined_at? metadata? name? profile_picture? role? team? type? updated_at? user?

    Properties

    agent?: Agent

    The agent associated with this membership, as an expanded agent object. null when the member is a user, the type is unknown, or the association is not preloaded.

    created_at?: string

    When this membership record was created (ISO 8601).

    id: string

    Team membership ID (tmb_...).

    joined_at?: string

    When the principal joined the team (ISO 8601).

    metadata?: Record<string, unknown>

    Arbitrary key-value metadata attached to this membership record. null if no metadata has been set.

    name?: string

    Display name of the member, derived from the associated user or agent. null if the principal is unknown.

    profile_picture?: ImageSource

    Profile picture of the member, derived from the associated user or agent. null if not set or principal is unknown.

    role?: string

    The member's role within the team. One of "owner", "admin", or "member".

    team?: Record<string, unknown>

    The team this membership belongs to, as an expanded team object. null when the team association is not preloaded.

    type?: string

    Resolved principal type. One of "user", "agent", or "unknown" when the principal cannot be determined.

    updated_at?: string

    When this membership record was last updated (ISO 8601).

    user?: User

    The user associated with this membership, as an expanded user object. null when the member is an agent, the type is unknown, or the association is not preloaded.

    Settings

    Member Visibility

    On This Page

    Properties