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

# Add a user by email

> `POST /v1/api/users` - add a member by email (no Slack/Teams needed). Creates
(or re-activates) a `workspace_users` row on the tenant's synthetic `direct`
source with `origin='email'`, `signin_access='allowed'`, then mints a
magic-link invite. Returns the link when no transactional email sender is
wired (so an admin can hand it over).



## OpenAPI

````yaml POST /v1/api/users
openapi: 3.1.0
info:
  title: HQ API
  description: >-
    Public HTTP API for HQ. Authenticate with a Personal Access Token
    (`Authorization: Bearer hq_pat_...`) for server-side integrations, or an
    OAuth 2.1 authorization-code + PKCE flow for browser apps acting on a user's
    behalf. Both grant from the same resource:action scope vocabulary; an
    endpoint's required scope is listed under its `security`.
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  version: 1.0.0
servers:
  - url: https://api.hq.zone
    description: HQ API (production)
security: []
tags:
  - name: me
    description: The signed-in user's own account
  - name: conversations
    description: Conversations and their messages
  - name: documents
    description: The content-addressed documents library
  - name: schedules
    description: Scheduled prompts and recurring tasks
  - name: agents
    description: Agents, their skills and integrations
  - name: memory
    description: What the assistant remembers (L5 governance)
  - name: tokens
    description: Personal Access Token management
  - name: billing
    description: Usage and billing
  - name: notifications
    description: In-app notification center
  - name: admin
    description: Workspace administration
  - name: integrations
    description: Workspace integrations (Slack, MCP, skills)
  - name: onboarding
    description: New-workspace onboarding wizard
  - name: auth
    description: Sign-in, sessions, and OAuth
paths:
  /v1/api/users:
    post:
      tags:
        - admin
      summary: Add a user by email
      description: >-
        `POST /v1/api/users` - add a member by email (no Slack/Teams needed).
        Creates

        (or re-activates) a `workspace_users` row on the tenant's synthetic
        `direct`

        source with `origin='email'`, `signin_access='allowed'`, then mints a

        magic-link invite. Returns the link when no transactional email sender
        is

        wired (so an admin can hand it over).
      operationId: add_user
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddUserReq'
        required: true
      responses:
        '200':
          description: User added / invited
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid email or admin_access
        '403':
          description: Admin role required
      security:
        - bearer_pat:
            - admin
        - oauth2:
            - admin
components:
  schemas:
    AddUserReq:
      type: object
      required:
        - email
      properties:
        admin_access:
          type:
            - string
            - 'null'
          description: >-
            `default` (normal member) or `granted` (tenant-admin from the
            start).
        display_name:
          type:
            - string
            - 'null'
        email:
          type: string
          description: >-
            Email of the person to add. This is a lookup + dedup attribute only
            -

            the identity key is a stable UUID (`external_user_id =
            workspace_users.id`),

            so the same human survives an email change. One row per (direct
            source,

            lowercased email); re-inviting updates that row, keeping its UUID.
  securitySchemes:
    bearer_pat:
      type: http
      scheme: bearer
      bearerFormat: hq_pat
      description: 'Personal Access Token. Send as `Authorization: Bearer hq_pat_...`.'
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hq.zone/v1/oauth/authorize
          tokenUrl: https://api.hq.zone/v1/oauth/token
          refreshUrl: https://api.hq.zone/v1/oauth/token
          scopes:
            admin: Administer the workspace (users, settings, integrations)
            agents:read: View the agents in your workspace
            agents:write: Create and configure agents
            billing:read: View usage and billing information
            conversations:read: Read your conversations and their messages
            conversations:write: Start conversations and send messages on your behalf
            documents:read: Read your documents library
            documents:write: Upload and manage documents in your library
            memory:read: Read what the assistant remembers about you
            memory:write: Correct or delete what the assistant remembers
            schedules:read: View your scheduled tasks
            schedules:write: Create and manage scheduled tasks
            tables:read: Read your tables and their rows
            tables:write: Create tables and add, edit, or delete rows

````