> ## 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. # List interviews > Retrieve interviews for a project. - Admins see all interviews in the project. - Other members see only interviews assigned to them or that they created. Results are ordered newest first, with interviews of the same campaign kept contiguous (a campaign sorts by its own creation date, a campaign-less interview by its own) — which is what lets clients render collapsible campaign groups across pages. ## OpenAPI ````yaml /api-reference/openapi-full.yaml get /projects/{project_id}/interviews/ 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 ` ## Organization API Key Authentication The user-provisioning endpoints authenticate with an **org-scoped API key** instead of a user token: - `Authorization: Api-Key ` The key is minted internally by Clarifeye (not self-service) and is scoped to a single organization — it can only act on the organization whose UUID matches the `{id}` in the request path. The email domains a key may pre-create accounts for are configured by Clarifeye on the organization (`allowed_provisioning_domains`). Once you have a key and your domains are set, call `POST /organizations/{id}/provision-user/` to pre-create users and `POST /organizations/{id}/deprovision-user/` to remove them. ## 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` (contact Clarifeye to enable this permission) **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 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: 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: Api-Key `). 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. paths: /projects/{project_id}/interviews/: get: tags: - Interviews summary: List interviews description: > Retrieve interviews for a project. - Admins see all interviews in the project. - Other members see only interviews assigned to them or that they created. Results are ordered newest first, with interviews of the same campaign kept contiguous (a campaign sorts by its own creation date, a campaign-less interview by its own) — which is what lets clients render collapsible campaign groups across pages. operationId: listInterviews parameters: - $ref: '#/components/parameters/ProjectId' - name: assigned_to in: query description: >- Set to "me" to return only interviews assigned to (or created by) the requesting user. schema: type: string enum: - me - name: created_by in: query description: >- Set to "me" to return only interviews the requesting user created (whoever they were assigned to). schema: type: string enum: - me - name: status in: query description: >- Filter by status. Comma-separated for multiple values (e.g. "pending,in_progress"). schema: type: string - name: campaign in: query description: > Filter by campaign: a campaign UUID for that campaign's interviews, or the literal "none" for interviews without a campaign. schema: type: string - name: text in: query description: Case-insensitive search over the interview name and transcript. schema: type: string - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset' responses: '200': description: Successful response content: application/json: schema: allOf: - $ref: '#/components/schemas/PaginatedResponse' - type: object properties: results: type: array items: $ref: '#/components/schemas/InterviewListItem' status_counts: type: object description: > Number of interviews per status across the whole filtered set (not just the returned page). Keys are the status values ("pending", "in_progress", "completed"); legacy conversations without a status are counted under "none". Absent keys mean zero. additionalProperties: type: integer '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' components: parameters: ProjectId: name: project_id in: path required: true description: UUID of the project schema: type: string format: uuid Limit: name: limit in: query description: Maximum number of results per page schema: type: integer default: 100 minimum: 1 maximum: 1000 Offset: name: offset in: query description: Number of results to skip for pagination schema: type: integer default: 0 minimum: 0 schemas: PaginatedResponse: type: object properties: count: type: integer description: Total number of results next: type: string format: uri nullable: true description: URL to next page of results previous: type: string format: uri nullable: true description: URL to previous page of results results: type: array items: {} InterviewListItem: type: object description: >- Lightweight interview representation used in list responses (omits the transcript). properties: id: type: string format: uuid readOnly: true name: type: string nullable: true created_by: type: string format: uuid readOnly: true created_by_email: type: string format: email nullable: true readOnly: true type: type: string assigned_to: type: string format: uuid nullable: true readOnly: true assigned_by: type: string format: uuid nullable: true readOnly: true assigned_to_email: type: string format: email nullable: true readOnly: true assigned_by_email: type: string format: email nullable: true readOnly: true is_pending_invite: type: boolean readOnly: true invite_config: allOf: - $ref: '#/components/schemas/InterviewInviteConfig' nullable: true readOnly: true import_info: allOf: - $ref: '#/components/schemas/ImportedInterviewInfo' nullable: true readOnly: true status: type: string nullable: true readOnly: true enum: - pending - in_progress - completed description: Null for imported interviews until their transcript parse completes. write_scope: type: string enum: - local - global campaign: allOf: - $ref: '#/components/schemas/InterviewCampaignRef' nullable: true readOnly: true description: Campaign this interview belongs to; null for ad hoc interviews. first_message_preview: type: string description: > Truncated preview of the first user message in the transcript. For imported transcripts this is the parse-generated summary when available (the literal first turn of a meeting export is usually greeting noise). message_count: type: integer description: Number of conversational messages in the transcript. topics_total: type: integer readOnly: true description: > Number of guided topics on the interview ("3/7 topics" progress on list rows). 0 for interviews without guided topics. topics_done: type: integer readOnly: true description: Guided topics no longer open (resolved or dismissed). created_at: type: string format: date-time readOnly: true updated_at: type: string format: date-time readOnly: true InterviewInviteConfig: type: object description: > Invitation-email customization and reminder schedule for an assigned interview. Null for self-assigned interviews, non-interview conversations, and interviews created before this feature existed. readOnly: true properties: custom_message: type: string description: >- The assigner's note; replaces the default invitation email copy when set. scheduled_send_at: type: string format: date-time nullable: true description: >- When the invitation email is (or was) due to be sent. Null means it was sent immediately. invitation_email_sent_at: type: string format: date-time nullable: true description: >- When the invitation email actually went out; null while a scheduled send is still pending. reminders_enabled: type: boolean reminder_start_after_days: type: integer reminder_interval_days: type: integer reminder_max_count: type: integer reminders_sent: type: integer description: Automatic reminders sent so far (manual reminders are not counted). next_reminder_at: type: string format: date-time nullable: true description: >- When the next automatic reminder is due; null when none is scheduled. reminders_stopped: type: boolean description: True once an admin/assigner stopped the schedule via stop-reminders. ImportedInterviewInfo: type: object description: > Parse-pipeline state of an imported external transcript (interviews of type "imported-interview"). Null on every other interview type. The raw pasted transcript is never returned — the parsed `chat_history` is the transcript. properties: import_status: type: string enum: - parsing - ready - failed description: > "parsing" while the async parse runs (transcript not yet readable), "ready" once chat_history holds the speaker-labeled turns (status becomes "completed"), "failed" when parsing errored (use retry-import). participants: type: array description: >- Participant names (importer-supplied or inferred from the transcript). items: type: string interview_date: type: string format: date nullable: true description: Date the conversation happened (importer-supplied or inferred). error: type: string nullable: true description: Failure detail when import_status is "failed". InterviewCampaignRef: type: object description: Nested campaign reference carried by interviews and drafts. properties: id: type: string format: uuid name: type: string Error: type: object properties: error: type: string description: Error message example: error: User not found 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. NotFound: description: Not found - resource does not exist content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Not found. securitySchemes: BearerAuth: type: http scheme: bearer description: 'Use Authorization: Bearer ' TokenAuth: type: apiKey in: header name: Authorization description: 'Use Authorization: Token ' ````