---
title: "GET /api/messages"
method: GET
path: "/api/messages"
tags: ["Practice Management"]
---

# GET /api/messages

`GET /api/messages`

## Request

- Base URL: `https://app.drchrono.com`
- URL: `https://app.drchrono.com/api/messages`
- Auth: OAuth 2
  - Authorization code: `https://app.drchrono.com/o/authorize/`
  - Token URL: `https://app.drchrono.com/o/token/` scopes: `messages:read`, `messages:write`

Retrieve or search messages in doctor's message center

## Query parameters

- `cursor` string: The pagination cursor value.
- `page_size` integer: Number of results to return per page.
- `patient` integer
- `doctor` integer
- `responsible_user` integer
- `updated_since` string
- `received_since` string
- `owner` integer
- `type` string

## Response `200`

OK

- object: Paginated Result
  - `previous` string: Previous paginated page
  - `data` DoctorMessage[]: result data
    - `type_description` string: Type Description
    - `patient_middle_name` string: Patient Middle Name
    - `updated_at` string
    - `owner` string: ID of `/api/users` who owns the message, who may be the doctor themselves or one of their staff members
    - `responsible_user_first_name` string: Responsible User First Name
    - `received_at` string
    - `id` integer
    - `doctor_last_name` string: Doctor Last Name
    - `owner_first_name` string: Owner First Name
    - `archived` boolean: If true, indicates that the message has been soft-deleted
    - `doctor` integer, required
    - `owner_last_name` string: Owner Last Name
    - `patient_first_name` string: Patient First Name
    - `attachment` string: Files are passed using `multipart/form-data` encoding, but returned as URLs.
    - `outgoing_fax_recipient_fax_number` string: Outgoing fax recipient fax number
    - `responsible_user_last_name` string: Responsible User Last Name
    - `type` 'GP' | 'GC' | 'GT' | 'GZ' | 'IF' | 'OF' | 'IL' | 'IR' | 'OR' | 'IE' | 'CE' | 'CH' | 'OA' | 'PO' | 'PI' | 'PM' | 'OO' | 'OD' | 'ID' | 'DL' | 'CN': Value | Description ----- | ----------- `"GP"` | Generated PDF `"GC"` | Generated CSV `"GZ"` | Generated ZIP `"IF"` | Incoming Fax `"OF"` | Outgoing Fax `"IL"` | Incoming Labs `"IR"` | Inbound Referrals `"OR"` | Outbound Referrals `"IE"` | Incoming eRx `"OA"` | Online Appointments `"PO"` | Patient Onboarding `"PI"` | Patient Incoming Message `"PM"` | Patient Outgoing Message `"OO"` | Demo Meeting Message `"OD"` | Outbound Direct Message `"ID"` | Inbound Direct Message
    - `patient_last_name` string: Patient Last Name
    - `patient` integer: ID of patient that the message concerns, if applicable
    - `doctor_first_name` string: Doctor First Name
    - `read` boolean
    - `responsible_user` string: ID of `/api/users` who has been assigned to process the message, who may be the doctor themselves or one of their staff members
    - `workflow_step` string: Used by doctors and their staff to keep track of what step of processing the message is in
    - `outgoing_fax_recipient_name` string: Outgoing fax recipient name
    - `doctor_middle_name` string: Doctor Middle Name
    - `message_notes` object[]: Array of notes attached to the message
      - `text` string: Content of the note
      - `created_at` string
      - `created_by` string: ID of `/api/users` who created the note
    - `title` string, required
    - `starred` boolean
  - `next` string: Next Paginated page

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Permission Denied
- `404`: Not Found
- `405`: Method Not Allowed
- `500`: Internal Server Error

---

[API](https://skmtc.dev/drchrono/apis/drchrono-api.md) - [All operations](https://skmtc.dev/drchrono/apis/drchrono-api/llms.txt) - [OpenAPI document](https://skmtc.dev/drchrono/apis/drchrono-api/revisions/98cabe79d150?raw)
