Skip to main content
POST
Suggest directory users as team members

Authorizations

Authorization
string
header
required

Team API key sent as a Bearer token. Create a key in Wirespeed under Settings → Team. See https://docs.wirespeed.co/api-reference/authentication.

Body

application/json

Prefix search: matches users whose email starts with the term or whose name has a word starting with it, at least 2 characters after trimming. When omitted, only high-confidence suggestions are returned.

Required string length: 2 - 512
size
integer
default:10

Maximum number of people to return

Required range: 1 <= x <= 50
excludeTeamMembers
boolean
default:true

When true, suggestions (requests without search) omit current members, pending invitees and former members of the team. Search results always include them with membershipStatus set.

includeFinancial
boolean
default:false

When true, FINANCIAL group members are also suggested. Intended for products with a finance role.

Response

data
object[]
required
hasMore
boolean
required

True when more people matched than size allowed