@archastro/sdk
    Preparing search index...
    Index

    Constructors

    Methods

    Constructors

    Methods

    • Remove a team membership by ID Removes a team membership identified directly by its membership ID. On success, returns 204 No Content. This endpoint is intended for server-to-server callers that already hold the membership ID. To remove a member by user or agent ID instead, use the team members delete endpoint. The caller must have permission to manage the team that the membership belongs to.

      Parameters

      • teamMembership: string

        Team membership ID (tmb_...) to remove. The membership must be within the caller's app scope.

      Returns Promise<void>

      Empty response. Returns 204 No Content on success.

    • List team memberships Returns a paginated list of team memberships across all teams accessible to the authenticated caller. Use the team, user, and agent filters to narrow results to a specific team or principal. This endpoint requires S2S (service-to-service) authentication. Callers authenticated with a user token receive a 401. Each membership includes the resolved type ("user", "agent", or "unknown"), display name, and profile picture derived from the associated user or agent at request time. Results are returned in offset-based pages. Pass page and page_size to navigate; the response includes has_next and has_prev to determine whether adjacent pages exist.

      Parameters

      • Optionalparams: {
            agent?: string[];
            page?: number;
            pageSize?: number;
            team?: string[];
            user?: string[];
        }

        Query parameters.

        • Optionalagent?: string[]

          Filter results to memberships held by these agent IDs (agt_...). Multiple values are combined with OR.

        • Optionalpage?: number

          Page number to retrieve, starting at 1. Defaults to 1.

        • OptionalpageSize?: number

          Number of memberships to return per page. Defaults to 25.

        • Optionalteam?: string[]

          Filter results to memberships belonging to these team IDs (tm_...). Multiple values are combined with OR.

        • Optionaluser?: string[]

          Filter results to memberships held by these user IDs (usr_...). Multiple values are combined with OR.

      Returns Promise<TeamMembershipListResponse>

      Paginated list of team memberships matching the applied filters.