searchTeam( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves all team members of the requesting account, based on the provided filters and free text queries.

Important: This call requires an account level API key and cannot be authenticated with the standard authorization header. API keys are currently available to selected beta users only.

Method Declaration
Copy
function searchTeam(options: SearchTeamOptions): Promise<SearchTeamResponse>;
Method Parameters
optionsSearchTeamOptions

Filter options.

Returns
Return Type:Promise<SearchTeamResponse>
Get account team members with an API key
JavaScript
import { createClient, ApiKeyStrategy } from "@wix/sdk";
import { users } from "@wix/user-management";
const wixClient = createClient({
  modules: { users },
  auth: ApiKeyStrategy({
    apiKey: "MY-API-KEY",
  }),
});

async function searchTeam(options) {
  const response = await users.searchTeam(options);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?