> ## Documentation Index > Fetch the complete documentation index at: https://docs.clarifeye.ai/llms.txt > Use this file to discover all available pages before exploring further. # Bulk invite users to project > Invite up to 100 email addresses in one call, all with the same permissions and profile. Each email is processed independently (partial success): existing users are added immediately, new users get a pending invite and a signup email, and rejected addresses (invalid, already a member, already invited, domain not allowed) are skipped without failing the batch. Duplicates within the batch are deduplicated case-insensitively. Requires admin permissions on the project. ## OpenAPI ````yaml /api-reference/openapi-full.yaml post /projects/{project_id}/invites/bulk-invite/ openapi: 3.0.3 info: title: Clarifeye Platform API — Full API Documentation description: > Complete REST API reference for the Clarifeye Platform. Documents every endpoint exposed by the platform — the public surface plus the advanced surface: pipeline customization (extraction flows, pipeline runs, warehouse tables, document tag/metadata configuration), the pre-MCP AI surface (agent settings, playground conversations, conversation-scoped feedback views, notifications), and the impersonation header. New AI integrations should consume knowledge via MCP rather than the conversation/agent-settings endpoints documented here. ## Authentication All endpoints require authentication. Include the Authorization header in every request using either format: - `Authorization: Token ` - `Authorization: Bearer ` ## Service accounts and API keys Integrations authenticate with an **API key** of a **service account**: - `Authorization: Bearer ` (keys start with `cfk_`) A service account is an ordinary member (role `member`) of one organization that cannot log in. Organization admins create it and mint its keys on the organization's *Service accounts* page (`/organizations/{id}/service-accounts/`, `/organization-api-keys/`), and give it access to knowledge stores with ordinary store permissions. A key is valid on every endpoint and acts as its service account: it reaches exactly the stores, with exactly the rights, the account was given. An account can hold several keys (each with its own name, optional expiry and revocation), so a key can be rotated without changing identity. A refused key answers **403** with one of: `Invalid API key.`, `API key revoked.`, `API key expired.`, `API key disabled.` (the service account is disabled). Any valid key may also call `POST /organizations/{id}/provision-user/` and `POST /organizations/{id}/deprovision-user/` for its own organization (the `{id}` in the path must be the key's organization). The email domains these may pre-create accounts for are configured by Clarifeye on the organization (`allowed_provisioning_domains`). ## Impersonation Certain endpoints support user impersonation for creating or listing data on behalf of other users. This is useful for integrating external systems that need to attribute actions to specific users. **Header:** `X-Impersonate-Email` **Required Permission:** `CAN_IMPERSONATE_OTHER_USERS` (for a person, contact Clarifeye to enable it; org admins grant it to a service account on the organization's Service accounts page) **Behavior:** - If the header is provided and the impersonator has the required permission, the action is performed as the target user - If the target user is not found, the request proceeds as the original authenticated user - If the target user does not have access to the project, the request proceeds as the original authenticated user - If the impersonator lacks the `CAN_IMPERSONATE_OTHER_USERS` permission, the header is ignored **With an API key** the request fails instead (**403**) whenever impersonation cannot happen: missing permission, unknown target, target without access to the store, target that is itself a service account, or an endpoint outside a store. A key never silently acts as its own service account when impersonation was asked for. version: 1.0.0 contact: name: Clarifeye Support servers: - url: https://eu.app.clarifeye.ai/api/v1 description: EU - url: https://us.app.clarifeye.ai/api/v1 description: US security: - BearerAuth: [] - TokenAuth: [] tags: - name: Users description: Manage users within a project - name: Invitations description: Manage project invitations - name: Documents description: Manage documents within a project - name: Agent Settings description: Manage AI agent configurations - name: Conversations description: Create and interact with AI-powered conversations - name: Interviews description: Assign and review structured interview conversations - name: Meetings description: >- Meetings Clara attends as a bot (Recall.ai) — live transcript, live insights, recording, and calendar scheduling (CLA-1843). Store admins only. - name: Feedback description: >- Submit and review feedback — standalone (content-only), agent-submitted (MCP), or linked to a conversation message - name: Tools description: Execute configured AI tools with custom parameters - name: Tables description: Perform CRUD operations on warehouse tables - name: Notifications description: Manage project-scoped notifications for users - name: Extraction Flows description: >- Manage extraction flows (auto-sync DAGs) — list, run, inspect statistics, update, and publish - name: Object Extractors description: | Extract structured data (instances of a Pydantic model) from chunks or blocks of documents. Update auto-creates a new `ObjectExtractorVersion` when version-bearing fields change. - name: Tag Extractors description: | Apply hierarchical metadata tags to chunks or documents using an LLM. Update auto-creates a new `TagExtractorVersion` when version-bearing fields change. - name: Chunks Extractors description: | Segment parsed documents into chunks for downstream processing. Update auto-creates a new `ChunksExtractorVersion` when version-bearing fields change. - name: Parsing Extractors description: | Convert source documents to text blocks via the parsing pipeline. Update auto-creates a new `ParsingExtractorVersion` when version-bearing fields change. - name: Document Filter Extractors description: | Restrict a downstream pipeline branch to documents matching a filter. Update auto-creates a new version when the filter changes. - name: Chunk Tag Filter Extractors description: | Restrict a downstream pipeline branch to chunks carrying specific tags. Update auto-creates a new version when the filter changes. - name: Document Tag Extractors description: | Apply a flat set of metadata tags to each document. Update auto-creates a new version when version-bearing fields change. - name: Tag Alerts Extractors description: | Run LLM-based alerts over already-extracted tag rows. Update auto-creates a new version when version-bearing fields change. - name: Object Alerts Extractors description: > Run LLM-based alerts over already-extracted object rows. Update auto-creates a new version when version-bearing fields change. - name: Imported Object Extractors description: | Hold objects imported from an external system (rather than extracted by an LLM). Useful for hydrating the warehouse with data produced outside the platform. - name: Pipeline Runs description: >- Inspect pipeline runs queued by extraction flows or other pipeline triggers — list runs and fetch the details/status of a single run - name: User Provisioning description: > Pre-create and de-provision org users via an org-scoped API key (`Authorization: Bearer `). The organization is resolved from the key. - name: Organization API Keys description: > Superuser management of org-scoped provisioning API keys. Minting and revoking are superuser-only; org admins can list/retrieve/reveal their own org's keys. - name: Design System Templates description: Reference/example files attached to a design template. - name: Artifacts description: | Knowledge-store artifact catalog — list artifacts, create/edit custom artifacts, manage scope membership, read and publish versions, configure the cohesion guide, and export/import the whole catalog. For type-aware reads and edits of artifact content, prefer the `read-write-*-artifact` tool endpoints. paths: /projects/{project_id}/invites/bulk-invite/: post: tags: - Invitations summary: Bulk invite users to project description: | Invite up to 100 email addresses in one call, all with the same permissions and profile. Each email is processed independently (partial success): existing users are added immediately, new users get a pending invite and a signup email, and rejected addresses (invalid, already a member, already invited, domain not allowed) are skipped without failing the batch. Duplicates within the batch are deduplicated case-insensitively. Requires admin permissions on the project. operationId: bulkInviteUsers parameters: - $ref: '#/components/parameters/ProjectId' requestBody: required: true content: application/json: schema: type: object required: - emails - permissions properties: emails: type: array maxItems: 100 items: type: string format: email description: Email addresses to invite example: - alice@example.com - bob@example.com permissions: type: array items: $ref: '#/components/schemas/PermissionType' description: Permissions granted to every invited user example: - CAN_VIEW_DATA profile: allOf: - $ref: '#/components/schemas/ProjectProfile' description: | Profile assigned to every invited user. Defaults to `contributor` when omitted. responses: '200': description: >- Per-email outcomes (returned even when some or all emails were skipped) content: application/json: schema: $ref: '#/components/schemas/BulkInviteResponse' '400': description: >- Bad request - malformed emails list, more than 100 emails, or invalid permissions/profile content: application/json: schema: $ref: '#/components/schemas/Error' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: parameters: ProjectId: name: project_id in: path required: true description: UUID of the project schema: type: string format: uuid schemas: PermissionType: type: string enum: - CAN_PERFORM_ADMIN_ACTIONS - CAN_VIEW_DATA - CAN_IMPERSONATE_OTHER_USERS description: > - `CAN_PERFORM_ADMIN_ACTIONS`: Full administrative access - `CAN_VIEW_DATA`: Read-only access to project data - `CAN_IMPERSONATE_OTHER_USERS`: Impersonate other users in API calls (for a person, contact Clarifeye to enable it; org admins grant it to a service account) ProjectProfile: type: string enum: - tech - contributor - user default: contributor description: | Profile of the user on the project. The profile shapes the UI surface a user sees (sidebar, available views) and complements the fine-grained `permissions` list. - `tech`: Technical profile with access to advanced/technical interfaces - `contributor`: Default profile for users who contribute to the project - `user`: End-user profile with the most restricted UI surface BulkInviteResponse: type: object properties: results: type: array description: Per-email outcomes, in request order after deduplication items: $ref: '#/components/schemas/BulkInviteResult' invited_new: type: integer added_existing: type: integer skipped: type: integer Error: type: object properties: error: type: string description: Error message example: error: User not found BulkInviteResult: type: object properties: email: type: string description: Normalized (lowercased) email address from the request status: type: string enum: - invited_new - added_existing - skipped description: | - `invited_new`: pending invite created, signup email sent - `added_existing`: existing user added immediately - `skipped`: nothing done, see `reason` reason: type: string nullable: true enum: - invalid_email - already_member - pending_invite - domain_not_allowed - error description: | Why the email was skipped; null unless status is `skipped`. `error` means an unexpected failure was contained to this address so the rest of the batch could proceed. responses: Unauthorized: description: Unauthorized - missing or invalid authentication content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Authentication credentials were not provided. Forbidden: description: Forbidden - insufficient permissions content: application/json: schema: $ref: '#/components/schemas/Error' example: error: You do not have permission to perform this action. securitySchemes: BearerAuth: type: http scheme: bearer description: > Use `Authorization: Bearer `. The token is either a user token / OAuth access token, or a service-account API key (`cfk_...`). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with `Invalid API key.`, `API key revoked.`, `API key expired.` or `API key disabled.`. TokenAuth: type: apiKey in: header name: Authorization description: 'Use Authorization: Token ' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.