> ## Documentation Index > Fetch the complete documentation index at: https://docs.corti.ai/llms.txt > Use this file to discover all available pages before exploring further. # List All Interactions > Lists all existing interactions. Results can be filtered by encounter status and patient identifier. ## OpenAPI ````yaml /api-reference/auto-generated-openapi.yml get /interactions/ openapi: 3.0.0 info: title: Corti API version: 2.0.0 servers: - url: https://api.{environment}.corti.app/v2/ variables: environment: default: eu enum: - us - eu security: - AuthorizationHeader: - bearer tags: - name: Interactions - name: Facts - name: Documents - name: Codes - name: Recordings - name: Transcripts paths: /interactions/: get: tags: - Interactions summary: List All Interactions description: >- Lists all existing interactions. Results can be filtered by encounter status and patient identifier. operationId: interactions_list parameters: - $ref: '#/components/parameters/Tenant-Name' - name: sort in: query description: Field used to sort interactions. Default is createdAt. schema: type: string description: Field used to sort interactions. Default is createdAt. default: createdAt enum: - id - assignedUserId - patient - createdAt - endedAt - updatedAt - name: direction in: query description: 'Sorting order. Allowed values: [asc, desc]. Default is desc.' schema: $ref: '#/components/schemas/CommonSortingDirectionEnum' - name: pageSize in: query description: >- Number of interactions to return per page. Must be greater than 0. Default is 10. schema: type: integer format: int64 description: >- Number of interactions to return per page. Must be greater than 0. Default is 10. - name: index in: query description: >- Page number to retrieve. Starts at 1. For example, index=2 with pageSize=10 will return interactions 11–20. Must be greater than 0. Default is 1. schema: type: integer format: int64 description: >- Page number to retrieve. Starts at 1. For example, index=2 with pageSize=10 will return interactions 11–20. Must be greater than 0. Default is 1. - name: encounterStatus in: query description: >- The status of the encounter. To filter on multiple statuses, pass the same parameter again. schema: type: array description: >- The status of the encounter. To filter on multiple statuses, pass the same parameter again. items: $ref: '#/components/schemas/InteractionsEncounterStatusEnum' style: form explode: true - name: patient in: query description: A unique identifier for the patient. schema: type: string description: A unique identifier for the patient. responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/InteractionsListResponse' '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: RFC9457 '504': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: RFC9457 x-codeSamples: - lang: csharp label: C# .NET SDK source: > using Corti; var client = new CortiClient( "TENANT_NAME", CortiClientEnvironment.Eu, new CortiClientAuth.ClientCredentials("client_id", "client_secret") ); var items = await client.Interactions.ListAsync(new InteractionsListRequest()); await foreach (var item in items) { // do something with item } - lang: javascript label: JavaScript SDK source: | import { CortiClient, CortiEnvironment } from "@corti/sdk"; const client = new CortiClient({ environment: CortiEnvironment.Eu, auth: { clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" }, tenantName: "YOUR_TENANT_NAME" }); const pageableResponse = await client.interactions.list(); for await (const item of pageableResponse) { console.log(item); } // Or you can manually iterate page-by-page let page = await client.interactions.list(); while (page.hasNextPage()) { page = page.getNextPage(); } // You can also access the underlying response const response = page.response; components: parameters: Tenant-Name: name: Tenant-Name in: header description: >- Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request. required: true example: base schema: type: string description: >- Identifies a distinct entity within Corti's multi-tenant system. Ensures correct routing and authentication of the request. example: base schemas: CommonSortingDirectionEnum: type: string example: desc enum: - asc - desc InteractionsEncounterStatusEnum: type: string enum: - planned - in-progress - on-hold - completed - cancelled - deleted InteractionsListResponse: type: object required: - interactions properties: interactions: type: array items: $ref: '#/components/schemas/InteractionsGetResponse' ErrorResponse: type: object required: - requestid - status - type - detail properties: requestid: type: string status: type: integer type: type: string detail: type: string validationErrors: type: array items: type: object additionalProperties: type: string InteractionsGetResponse: type: object required: - id - assignedUserId - encounter - patient - createdAt - updatedAt - lastUpdated - websocketUrl properties: id: $ref: '#/components/schemas/UUID' type: string format: uuid description: Unique identifier for the interaction. items: {} assignedUserId: $ref: '#/components/schemas/UUID' type: string format: uuid description: >- A unique identifier for the medical professional responsible for this interaction. If nulled, automatically set to a uuid. items: {} encounter: $ref: '#/components/schemas/InteractionsEncounterResponse' type: object description: Information about the encounter, including type, status, and timing. patient: $ref: '#/components/schemas/InteractionsPatient' type: object description: >- Details about the patient involved in the interaction, if applicable. endedAt: type: string format: date-time description: The timestamp when the interaction concluded (UTC). nullable: true createdAt: type: string format: date-time description: The timestamp when the interaction was started (UTC). updatedAt: type: string format: date-time description: The timestamp when the interaction was last modified (UTC). websocketUrl: type: string description: >- WebSocket URL for streaming real-time interactions. Append a token in the format: /interactions/{interactionID}/streams?token=Bearer token-value-here lastUpdated: type: string format: date-time description: >- The timestamp indicating the last recorded update for this interaction. UUID: type: string items: {} format: uuid example: f47ac10b-58cc-4372-a567-0e02b2c3d479 InteractionsEncounterResponse: type: object required: - identifier - status - type - period properties: identifier: type: string description: >- A unique identifier for the encounter, essential for tracking and referencing specific patient interactions. status: $ref: '#/components/schemas/InteractionsEncounterStatusEnum' description: >- Indicates the current state of the encounter, crucial for understanding the progression and current state of care. type: $ref: '#/components/schemas/InteractionsEncounterTypeEnum' description: >- The specific type of encounter, providing context about the nature and setting of the patient interaction. period: $ref: '#/components/schemas/InteractionsEncounterPeriod' type: object description: The time period during which the encounter takes place. title: type: string description: A readable name for the interaction nullable: true InteractionsPatient: type: object required: - identifier properties: identifier: type: string description: FHIR reference to patient identifier. name: type: string description: FHIR reference to Text representation of the full name. nullable: true gender: $ref: '#/components/schemas/InteractionsGenderEnum' description: FHIR reference to patient gender. nullable: true birthDate: type: string format: date-time description: FHIR reference to patient birth date. nullable: true pronouns: type: string description: FHIR reference to patient extension Individual Pronouns. nullable: true InteractionsEncounterTypeEnum: type: string enum: - first_consultation - consultation - emergency - inpatient - outpatient InteractionsEncounterPeriod: type: object required: - startedAt properties: startedAt: type: string format: date-time description: The start date/time of the encounter. (UTC) endedAt: type: string format: date-time description: The end date/time of the encounter. (UTC) nullable: true InteractionsGenderEnum: type: string enum: - male - female - unknown - other securitySchemes: AuthorizationHeader: type: http description: Input your token scheme: bearer ````