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

# List inbox assignments

> Returns all PENDING or IN_PROGRESS assignments addressed to the current user. Cosmos container `assignments` is partitioned by `/assigneeEmail`; this query is a direct partition scan against the caller's UPN. **Experimental** — only accessible when the `experimental` flag is enabled.




## OpenAPI

````yaml /api-reference/openapi.json get /assignments/inbox
openapi: 3.0.3
info:
  title: Findable API
  version: 3.2.38
  description: >
    REST API for the Findable AI Assistant platform.


    ## Authentication


    All endpoints (except `/server/setup` and `/server/bootstrap`) require a
    valid **Azure AD / Entra ID Bearer token**.


    ### Obtaining a token


    1. Register (or reuse) an **App Registration** in Azure Entra ID for your
    client.

    2. Under **API Permissions**, add a delegated permission for the Findable
    server app:
       `api://<SERVER_CLIENT_ID>/User.Read`
    3. Acquire a token using MSAL (or any OAuth 2.0 library) with the following
    parameters:


    | Parameter | Value |

    |-----------|-------|

    | Authority | `https://login.microsoftonline.com/<TENANT_ID>` |

    | Client ID | Your client app registration ID |

    | Scope | `api://<SERVER_CLIENT_ID>/User.Read` |

    | Grant type | Authorization Code (interactive) or Client Credentials
    (daemon) |


    ### Example (MSAL Node.js)


    ```javascript

    const { ConfidentialClientApplication } = require("@azure/msal-node");


    const cca = new ConfidentialClientApplication({
      auth: {
        clientId: "<YOUR_CLIENT_ID>",
        authority: "https://login.microsoftonline.com/<TENANT_ID>",
        clientSecret: "<YOUR_CLIENT_SECRET>",
      },
    });


    const result = await cca.acquireTokenByClientCredential({
      scopes: ["api://<SERVER_CLIENT_ID>/.default"],
    });


    // Use result.accessToken in the Authorization header

    ```


    ### Using the token


    Include the token in every request:

    ```

    Authorization: Bearer <access_token>

    ```


    ### Roles


    Access is determined by Azure AD group membership configured in the
    application settings:

    - **Admin (Owner)**: Full access to all endpoints including admin operations

    - **Contributor**: Can create and manage chats, files, and content

    - **User**: Read access to entitled chats and resources
  contact:
    name: Findable Support
  license:
    name: Proprietary
servers:
  - url: /server
    description: Application server (relative)
security:
  - BearerAuth: []
tags:
  - name: AI
    description: Chat completion and AI generation endpoints
  - name: Chats
    description: Chat configuration CRUD with ACL enforcement
  - name: Settings
    description: Application settings and health
  - name: Files
    description: Blob storage file operations
  - name: Search
    description: Azure AI Search resource management
  - name: User
    description: User profile, feedback, chat logs, and preferences
  - name: Flows
    description: FlowEngine flow designer operations
  - name: Prompts
    description: Prompt template management
  - name: Pages
    description: Navigation page management
  - name: Admin
    description: Administrative operations (admin-only)
  - name: Bootstrap
    description: Bootstrap seed data operations (admin-only)
  - name: Setup
    description: Initial application setup (pre-auth)
  - name: Cosmos
    description: Generic Cosmos DB CRUD operations
  - name: Tools
    description: Tool providers, web search, and utility tools
  - name: MCP
    description: Model Context Protocol server management
  - name: Telemetry
    description: Version, health, and API permission checks
  - name: SharePoint
    description: SharePoint entitlement management
  - name: Data Platform
    description: Data platform connection management
  - name: Vector Stores
    description: Vector store provider operations
  - name: OneDrive
    description: OneDrive personal file storage operations
  - name: Jobs
    description: Background job and scheduler management
  - name: Memory
    description: User and organizational memory operations
  - name: Slack
    description: >-
      Slack bot interactions and webhooks (public, uses Slack signature
      verification)
  - name: Teams
    description: Microsoft Teams bot webhooks and interactions
  - name: Human Input
    description: Human-in-the-loop input requests for flow executions
  - name: Datasources
    description: Datasource catalog CRUD with ACL enforcement
  - name: Assignments
    description: >-
      Assignment lifecycle: inbox, sent, create, launch, complete, delegate,
      reject, reassign, remind, and recurring schedules. Experimental feature —
      requires experimental flag enabled.
paths:
  /assignments/inbox:
    get:
      tags:
        - Assignments
      summary: List inbox assignments
      description: >
        Returns all PENDING or IN_PROGRESS assignments addressed to the current
        user. Cosmos container `assignments` is partitioned by `/assigneeEmail`;
        this query is a direct partition scan against the caller's UPN.
        **Experimental** — only accessible when the `experimental` flag is
        enabled.
      responses:
        '200':
          description: Array of active assignments for the caller
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Assignment'
        '401':
          description: Not authenticated
        '500':
          description: Internal error
components:
  schemas:
    Assignment:
      type: object
      properties:
        id:
          type: string
        targetType:
          type: string
          enum:
            - chat
            - document
            - survey
        targetId:
          type: string
        targetVersion:
          type: string
        targetTitle:
          type: string
        assigneeEmail:
          type: string
        assignedBy:
          type: string
        originatorEmail:
          type: string
        originatorName:
          type: string
        originatorMessage:
          type: string
        dueAt:
          type: string
        expiresAt:
          type: string
        completionCriteria:
          type: string
          enum:
            - chat_visited
            - chat_engaged
            - flow_started
            - flow_completed
            - flow_passed
            - manual
        maxAttempts:
          type: integer
        attempts:
          type: array
          items:
            type: object
            properties:
              chatLogId:
                type: string
              startedAt:
                type: string
              completedAt:
                type: string
              outcome:
                type: string
                enum:
                  - success
                  - failure
                  - abandoned
              score:
                type: number
              outcomeData:
                type: object
                additionalProperties: {}
              note:
                type: string
            required:
              - startedAt
            additionalProperties: false
        status:
          type: string
          enum:
            - pending
            - in_progress
            - completed
            - failed
            - expired
            - cancelled
            - rejected
            - delegated
        cancelledAt:
          type: string
        cancelledBy:
          type: string
        cancellationReason:
          type: string
        allowRejection:
          type: boolean
        rejectedAt:
          type: string
        rejectedBy:
          type: string
        rejectionReason:
          type: string
        allowDelegation:
          type: boolean
        delegatedFrom:
          type: string
        delegatedTo:
          type: string
        delegationChain:
          type: array
          items:
            type: string
        delegationReason:
          type: string
        reassignedFrom:
          type: string
        scheduleId:
          type: string
        lastReminderAt:
          type: string
        remindersSent:
          type: integer
        createdAt:
          type: string
        updatedAt:
          type: string
        createdBy:
          type: string
        updatedBy:
          type: string
        _ts:
          type: number
        _etag:
          type: string
      required:
        - id
        - targetType
        - targetId
        - assigneeEmail
        - assignedBy
        - originatorEmail
        - completionCriteria
        - attempts
        - status
        - delegationChain
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Azure AD access token obtained via MSAL

````