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

# Invite members

> Invite accounts to one or more workspace groups.

Requires an OAuth bearer token and Admin or Owner permission for **every** target group. Send recipient `emails` and `targets` containing `organization_id` and `role`. This sends invitation emails.

Inspect both `created` and `skipped` in the response; one successful HTTP response does not mean every recipient received a new invitation. Empty/invalid targets or roles return `400`; insufficient target access returns `403`. API keys are not accepted.


## OpenAPI

````yaml POST /api/v1/organizations/invites
openapi: 3.1.0
info:
  title: Bandwidth Agent Builder API
  version: v1
  description: >-
    Manage agents, place calls, and retrieve conversation results in your
    workspace.
servers:
  - url: https://agents.labs.bandwidth.com
    description: Workspace API
security: []
paths:
  /api/v1/organizations/invites:
    post:
      tags:
        - members
      summary: Invite members
      description: >-
        **Authorization:** Requires a Labs OAuth bearer token. API keys are not
        accepted. Resource ownership and operation-specific restrictions still
        apply.


        Invite accounts to one or more workspace groups.
      operationId: invite_members_api_v1_organizations_invites_post
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteMembersRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteMembersResponse'
          description: Successful Response
        '401':
          description: Missing, invalid, or expired credential.
        '403':
          description: >-
            The account lacks access to the workspace, resource, or required
            role.
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - LabsAuth: []
components:
  schemas:
    InviteMembersRequest:
      properties:
        emails:
          items:
            format: email
            type: string
          title: Emails
          type: array
        targets:
          items:
            $ref: '#/components/schemas/InviteTarget'
          title: Targets
          type: array
      required:
        - emails
        - targets
      title: InviteMembersRequest
      type: object
    InviteMembersResponse:
      properties:
        created:
          items:
            $ref: '#/components/schemas/InviteResponse'
          title: Created
          type: array
        skipped:
          items:
            $ref: '#/components/schemas/SkippedInvite'
          title: Skipped
          type: array
      required:
        - created
        - skipped
      title: InviteMembersResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    InviteTarget:
      properties:
        organization_id:
          title: Organization Id
          type: integer
        role:
          default: viewer
          title: Role
          type: string
      required:
        - organization_id
      title: InviteTarget
      type: object
    InviteResponse:
      properties:
        email:
          title: Email
          type: string
        expires_at:
          format: date-time
          title: Expires At
          type: string
        id:
          title: Id
          type: integer
        role:
          title: Role
          type: string
        status:
          title: Status
          type: string
      required:
        - id
        - email
        - role
        - status
        - expires_at
      title: InviteResponse
      type: object
    SkippedInvite:
      properties:
        email:
          title: Email
          type: string
        reason:
          title: Reason
          type: string
      required:
        - email
        - reason
      title: SkippedInvite
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    LabsAuth:
      description: >-
        Bandwidth Labs OAuth access token. Uses the user's selected workspace;
        the workspace header is not required. Do not also send an API key.
        Bearer-only operations may additionally require the Labs `super_user`
        role.
      scheme: bearer
      type: http

````

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