---
title: "List assistant instances"
method: GET
path: "/assistantInstances"
tags: ["assistantInstances"]
---

# List assistant instances

`GET /assistantInstances`

## Request

- Base URL: `https://api.lumahealth.io/api/v2`
- URL: `https://api.lumahealth.io/api/v2/assistantInstances`
- Auth: HTTP bearer

## Query parameters

- `assistant` string
- `patient` string
- `patient.name` string
- `status` 'idle' | 'in-progress' | 'failure' | 'success'
- `user` string
- `deleted` 0 | 1
- `createdBy` string
- `updatedBy` string
- `createdAt` string, date-time
- `updatedAt` string, date-time
- `page` integer
- `limit` integer
- `_populate` string
- `_select` string

## Response `200`

List of assistant instances

- object
  - `response` AssistantInstanceResponse[], required
    - `_id` string: Luma's internal ID of an object.
    - `user` string: The ID of the root account user.
    - `deleted` 0 | 1: Flag for logical deletion where 1 means deleted.
    - `createdBy` string: The ID of the user who created this object.
    - `updatedBy` string: The ID of the user who updated this object.
    - `createdAt` string, date-time: The date/time when this object was created.
    - `updatedAt` string, date-time: The date/time when this object was updated.
    - `release` 'current' | 'next' | 'preProd': Which release track of the assistant handled this conversation.
    - `patient` string: ID of the patient in this conversation.
    - `verified` boolean: Whether the patient's identity has been confirmed.
    - `onBehalfOf` string: ID of the patient being discussed, when different from `patient` (for example, a guardian calling about a dependent).
    - `status` 'idle' | 'in-progress' | 'failure' | 'success': Lifecycle status of the conversation.
    - `statusUpdatedAt` string, date-time: When `status` was last updated.
    - `statusReason` 'success-by-assistant' | 'success-by-transfer' | 'success-by-patient' | 'success-by-staff' | 'success-by-assistant-timeout' | 'failure-by-assistant' | 'failure-by-patient' | 'failure-by-staff' | 'incomplete-success-criteria' | 'timed-out' | 'no-new-messages' | 'maximum-retries': Why the conversation reached its terminal status.
    - `assistant` string: ID of the Assistant configuration driving this conversation.
    - `entryPoints` object[]: The channels used to reach the assistant during this conversation.
      - `channel` 'sms' | 'email' | 'voice' | 'inapp' | 'chat' | 'fax' | 'whatsapp' | 'rcs' | 'lumabot' | 'internal'
      - `lastMessageAt` string, date-time
      - `direction` 'inbound' | 'outbound'
    - `startedAt` string, date-time
    - `finishedAt` string, date-time
    - `duration` number: Duration of the conversation, in seconds.
    - `reporting` object: Structured reporting/QA data collected about this conversation.
      - `callOutcome` 'transferred' | 'assistant-ended' | 'patient-ended' | 'timed-out'
      - `intents` object[]: The intents detected during the conversation.
        - `intent` string
        - `inScope` boolean
        - `handled` boolean
        - `evidence` string: ID of the message that evidences this intent.
      - `summary` string
      - `callTransferAttempt` boolean
      - `transferWasAfterHours` boolean
  - `page` integer, required
  - `size` integer, required

## Other responses

- `401`: Not authenticated
- `403`: Access token does not have the required scope

---

[API](https://skmtc.dev/lumahealth/apis/rest-service.md) - [All operations](https://skmtc.dev/lumahealth/apis/rest-service/llms.txt) - [OpenAPI document](https://skmtc.dev/lumahealth/apis/rest-service/revisions/f19aeba84a26?raw)