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

# inviteUser

> POST /api/users/invitations
Invite a user into by email with the specified permissions



## OpenAPI

````yaml /api-reference/openapi.json post /api/users/invitations
openapi: 3.0.3
info:
  title: Parable API
  description: >-
    The REST API for your Parable workspace: manage connectors and taps, explore
    your data catalog, upload artifacts, and administer users and roles.
  version: v1
servers:
  - url: https://api.askparable.com
    description: Production
security: []
paths:
  /api/users/invitations:
    post:
      tags:
        - users
      summary: inviteUser
      description: |-
        POST /api/users/invitations
        Invite a user into by email with the specified permissions
      operationId: UsersInviteUserHandler
      parameters:
        - description: >-
            Workspace slug. Overrides subdomain-based workspace resolution when
            provided.
          in: header
          name: X-Tenant
          required: false
          schema:
            example: acme
            type: string
        - description: Optional request correlation ID echoed back in the response.
          in: header
          name: X-Request-ID
          required: false
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteTenantUserInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/UserBase'
                  links:
                    $ref: '#/components/schemas/ResponseLinks'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - data
                  - meta
                type: object
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      security:
        - bearerAuth: []
components:
  schemas:
    InviteTenantUserInput:
      properties:
        email:
          description: An email address
          type: string
        roleIds:
          description: >-
            Role IDs to assign to the user upon invite. At least one role is
            required.
          items:
            description: UUID v4 with automatic base62 encoding for client-facing APIs
            type: string
          type: array
      required:
        - email
        - roleIds
      type: object
    UserBase:
      description: |-
        The base info about a user. id stays Identity.UserID (not Auditable's
        Identity.UUID) so the wire/auth contract keeps the actor scalar.
      properties:
        avatarUrl:
          description: >-
            Profile picture URL. Mirrors User.avatar.url (custom upload,
            re-hosted OAuth

            avatar, or the provider `picture` claim). Null for email-code
            signups; the UI

            falls back to an initials avatar.
          type: string
        createdAt:
          description: ISO8601 datetime string
          type: string
        createdBy:
          description: UUID v4 string as base62
          type: string
        email:
          description: An email address
          type: string
        id:
          description: UUID v4 string as base62
          type: string
        locale:
          description: BCP 47 language tag (e.g., en-US, fr-FR)
          type: string
        name:
          description: An objects name
          type: string
        staffRoles:
          description: >-
            Staff/platform-level roles assigned via StaffUserRole. Each role
            carries

            its own inline permissions; aggregate via hasPermission(staffRoles,
            perm).
          items:
            $ref: '#/components/schemas/Role'
          type: array
        timezone:
          description: IANA timezone identifier (e.g., America/New_York)
          type: string
        title:
          type: string
        updatedAt:
          description: ISO8601 datetime string
          type: string
        updatedBy:
          description: UUID v4 string as base62
          type: string
        userOnboardingCompletedAt:
          description: ISO8601 datetime string
          type: string
        welcomeSeenAt:
          description: ISO8601 datetime string
          type: string
      required:
        - id
        - createdAt
        - createdBy
        - updatedAt
        - updatedBy
        - email
        - staffRoles
      type: object
    ResponseLinks:
      properties:
        first:
          nullable: true
          type: string
        last:
          nullable: true
          type: string
        next:
          nullable: true
          type: string
        prev:
          nullable: true
          type: string
      type: object
    ResponseMeta:
      properties:
        requestId:
          description: Unique identifier for the request
          type: string
        totalCount:
          description: Total count of items for paginated responses
          nullable: true
          type: integer
      required:
        - requestId
      type: object
    Error:
      properties:
        error:
          type: string
      type: object
    Role:
      description: >-
        Wire Role shape is owned by web-shared-types; local alias keeps barrels
        stable.
      properties:
        createdAt:
          description: ISO8601 datetime string
          type: string
        createdBy:
          description: UUID v4 string as base62
          type: string
        description:
          type: string
        id:
          description: UUID v4 with automatic base62 encoding for client-facing APIs
          type: string
        name:
          type: string
        parentRoleId:
          description: Parent role ID for tracking/analytics. Null if this is a base role.
          type: string
        permissions:
          items:
            description: Hierarchical permission string (e.g., 'admin.users.read')
            type: string
          type: array
      required:
        - id
        - createdAt
        - createdBy
        - name
        - permissions
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````