> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wirespeed.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Suggest directory users as team members

> Without search, returns employees (no guests or non-human identities) in the ADMIN group by an administrator-role rule, title rule or manual assignment, or in the TECHNICAL group by a title rule or manual assignment; FINANCIAL group members are added when includeFinancial is true. Results are ranked strongest signal first, and with excludeTeamMembers omit current, invited and former members. With search, returns any user whose email or a word of whose name starts with the term. Each result carries the relationship of its email to the team.



## OpenAPI

````yaml https://api.wirespeed.co/v1/openapi.json post /v1/directory/member-suggestions
openapi: 3.0.0
info:
  title: Wirespeed API
  description: The public Wirespeed API. v1 is the first stable contract.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wirespeed.co
security: []
tags: []
paths:
  /v1/directory/member-suggestions:
    post:
      tags:
        - Directory
      summary: Suggest directory users as team members
      description: >-
        Without search, returns employees (no guests or non-human identities) in
        the ADMIN group by an administrator-role rule, title rule or manual
        assignment, or in the TECHNICAL group by a title rule or manual
        assignment; FINANCIAL group members are added when includeFinancial is
        true. Results are ranked strongest signal first, and with
        excludeTeamMembers omit current, invited and former members. With
        search, returns any user whose email or a word of whose name starts with
        the term. Each result carries the relationship of its email to the team.
      operationId: DirectoryController_suggestMembers
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MemberSuggestionSearchDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberSuggestionPage'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
      security:
        - bearer: []
components:
  schemas:
    MemberSuggestionSearchDto:
      type: object
      properties:
        search:
          type: string
          minLength: 2
          maxLength: 512
          description: >-
            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.
        size:
          type: integer
          default: 10
          minimum: 1
          maximum: 50
          description: Maximum number of people to return
        excludeTeamMembers:
          type: boolean
          default: true
          description: >-
            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:
          type: boolean
          default: false
          description: >-
            When true, FINANCIAL group members are also suggested. Intended for
            products with a finance role.
    MemberSuggestionPage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MemberSuggestionDto'
        hasMore:
          type: boolean
          description: True when more people matched than `size` allowed
      required:
        - data
        - hasMore
    HttpError:
      type: object
      properties:
        message:
          type: string
        statusCode:
          type: number
        code:
          type: string
          description: >-
            Stable machine-readable error code. Clients should branch and
            translate on this instead of `message`.
        params:
          type: object
          description: Values interpolated into the message for `code`.
          additionalProperties:
            oneOf:
              - type: string
              - type: number
              - type: boolean
            nullable: true
        validationErrors:
          description: >-
            Per-property failures when `code` is `VALIDATION_FAILED` from
            request validation.
          type: array
          items:
            $ref: '#/components/schemas/HttpValidationIssue'
      required:
        - message
        - statusCode
    MemberSuggestionDto:
      type: object
      properties:
        directoryUserId:
          type: string
          format: uuid
        email:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        title:
          type: string
          nullable: true
        department:
          type: string
          nullable: true
        integrationPlatform:
          type: string
          nullable: true
        accessLevel:
          type: string
          enum:
            - admin
            - technical
            - financial
          nullable: true
          description: >-
            Coarse access signal for ranking and badges. It never implies a
            role.
          x-extensible-enum: true
        reasons:
          type: array
          items:
            $ref: '#/components/schemas/MemberSuggestionReasonDto'
        membershipStatus:
          type: string
          enum:
            - member
            - invited
            - former
          nullable: true
          description: Relationship of this email to the requesting team
          x-extensible-enum: true
      required:
        - directoryUserId
        - email
        - firstName
        - lastName
        - title
        - department
        - integrationPlatform
        - accessLevel
        - reasons
        - membershipStatus
    HttpValidationIssue:
      type: object
      properties:
        property:
          type: string
          description: Dotted path of the invalid property.
        constraint:
          type: string
          description: >-
            class-validator constraint name; clients translate
            `errors:validation.<constraint>`.
        params:
          type: object
          description: Values interpolated into the constraint message.
          additionalProperties:
            oneOf:
              - type: string
              - type: number
              - type: boolean
            nullable: true
        code:
          type: string
          description: Catalog code overriding the constraint translation.
      required:
        - property
        - constraint
        - params
    MemberSuggestionReasonDto:
      type: object
      properties:
        type:
          type: string
          enum:
            - directory_admin_role
            - admin_title
            - technical_title
            - financial_group
          x-extensible-enum: true
        detail:
          type: string
          description: Matched directory role name for directory_admin_role
      required:
        - type
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: API key
      type: http
      description: >-
        Team API key sent as a Bearer token. Create a key in Wirespeed under
        Settings → Team. See
        https://docs.wirespeed.co/api-reference/authentication.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.