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

# Get a conversation



## OpenAPI

````yaml /api-reference/openapi.json get /v1/conversations/{conversation_id}
openapi: 3.1.0
info:
  title: Ciarem API
  version: v1
  description: >
    The Ciarem public API. Authenticate every request with an org-bound API key

    (created in Settings → API keys; Scale plan or free trial) sent as a bearer
    token:

    `Authorization: Bearer oak_…`.


    Compatibility: this is an early, fast-moving API. Most changes are

    additive (new endpoints, new optional params, new response fields, new

    enum/string values) — clients must tolerate unknown fields and unknown

    string values. Every contract change is listed in the changelog at

    help.ciarem.ai.
servers:
  - url: https://api.ciarem.ai
security:
  - apiKey: []
tags:
  - name: Account
    description: The organization behind the API key.
  - name: Contacts
    description: People in the CRM — create, read, update, delete.
  - name: CRM
    description: 'The shape of the CRM: custom properties and funnel stages.'
  - name: Conversations
    description: Read the message history of a conversation.
  - name: WhatsApp numbers
    description: The connected numbers a send can go out from.
  - name: WhatsApp templates
    description: Message templates, and what each one needs filled before it can be sent.
  - name: Broadcasts
    description: Send a template, and follow what happened to every recipient.
paths:
  /v1/conversations/{conversation_id}:
    get:
      tags:
        - Conversations
      summary: Get a conversation
      operationId: get_endpoint_v1_conversations__conversation_id__get
      parameters:
        - name: conversation_id
          in: path
          required: true
          schema:
            type: string
            title: Conversation Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicConversationDetail'
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
        '401':
          description: >-
            No usable credential: `missing_bearer_token` (no `Authorization:
            Bearer`) or `invalid_api_key` (unknown or revoked key).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
        '403':
          description: >-
            The credential is real but not allowed here: `api_key_required` (a
            session token rather than an `oak_` key), `scale_plan_required` (a
            live plan below Scale — upgrade to Scale), `trial_expired` (the free
            trial ended without a card — subscribe to keep the key working), or
            `subscription_required` (the subscription is canceled or suspended).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: >-
            Over the organization's request budget (`rate_limited`).
            `Retry-After` says how many seconds to wait.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicError'
          headers:
            Retry-After:
              description: Seconds until the window resets.
              schema:
                type: integer
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
components:
  schemas:
    PublicConversationDetail:
      properties:
        id:
          type: string
          title: Id
        channel_kind:
          $ref: '#/components/schemas/ChannelKind'
        channel_id:
          type: string
          title: Channel Id
        external_id:
          type: string
          title: External Id
        display_name:
          type: string
          title: Display Name
        handled_by:
          $ref: '#/components/schemas/ConversationHandler'
        status:
          $ref: '#/components/schemas/ConversationStatus'
        assignee_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee Id
        team_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Team Id
        contact_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Contact Id
        last_inbound_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Inbound At
        last_message_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Message At
        resolved_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Resolved At
        created_at:
          type: string
          format: date-time
          title: Created At
        summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Summary
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
        - id
        - channel_kind
        - channel_id
        - external_id
        - display_name
        - handled_by
        - status
        - assignee_id
        - team_id
        - contact_id
        - last_inbound_at
        - last_message_at
        - resolved_at
        - created_at
        - summary
        - updated_at
      title: PublicConversationDetail
    PublicError:
      description: An error whose `detail` is a stable, machine-readable code.
      properties:
        detail:
          title: Detail
          type: string
      required:
        - detail
      title: PublicError
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ChannelKind:
      type: string
      enum:
        - whatsapp
        - instagram
        - messenger
        - webchat
      title: ChannelKind
      description: Connected messaging channel kinds. Stored in `channels.kind`.
    ConversationHandler:
      type: string
      enum:
        - ai
        - human
        - whatsapp_app
      title: ConversationHandler
      description: >-
        Who is currently handling a conversation. The AI runs only while `ai`;

        while `human` or `whatsapp_app` inbound messages bypass the AI and
        surface in

        the inbox.
    ConversationStatus:
      type: string
      enum:
        - open
        - resolved
        - closed
      title: ConversationStatus
      description: >-
        Lifecycle of a conversation. There is no `expired` value: WhatsApp 24h

        "expiry" is a derived window state (`now - last_inbound_at >= 24h`), not
        a

        lifecycle status — an expired thread is still `open`.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  headers:
    X-RateLimit-Limit:
      description: Requests allowed per window, shared across the org's keys.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests left in the current window.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: When the window resets, as a Unix timestamp in seconds.
      schema:
        type: integer
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'An org API key: `Authorization: Bearer oak_…`.'

````