List Letters - Elation Help Center

GET

api

2.0

letters

List Letters

curl --request GET \
  --url https://sandbox.elationemr.com/api/2.0/letters/ \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "patient": 123,
      "practice": 123,
      "send_to_contact": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>",
        "npi": "<string>",
        "org_name": "<string>",
        "specialties": [
          "<unknown>"
        ]
      },
      "attachments": [
        {
          "entity_date": "2023-11-07T05:31:56Z",
          "entity_description": "<string>",
          "entity_id": 123,
          "entity_type": 123,
          "handout": 123,
          "id": 123,
          "summary": "<string>"
        }
      ],
      "body": "<string>",
      "created_date": "2023-11-07T05:31:56Z",
      "deleted_date": "2023-11-07T05:31:56Z",
      "delivery_date": "2023-11-07T05:31:56Z",
      "direct_message_status": "<string>",
      "direct_message_to": "<string>",
      "display_to": "<string>",
      "document_date": "2023-11-07T05:31:56Z",
      "email_to": "<string>",
      "failure_unacknowledged": "<string>",
      "fax_attachments": true,
      "fax_status": "<string>",
      "fax_to": "<string>",
      "id": 123,
      "is_processed": true,
      "letter_type": "<string>",
      "referral_order": 123,
      "send_out": true,
      "send_to_elation_user": 123,
      "send_to_name": "<string>",
      "sign_date": "2023-11-07T05:31:56Z",
      "signed_by": 123,
      "subject": "<string>",
      "tags": [
        123
      ],
      "to_number": "<string>",
      "viewed_at": "2023-11-07T05:31:56Z",
      "with_archive": true
    }
  ],
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

document_date__gt

string<date-time>

document_date__gte

string<date-time>

document_date__lt

string<date-time>

document_date__lte

string<date-time>

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

patient

integer<int64>[]

practice

integer<int64>[]

recipient_id

integer<int64>[]

recipient_name

string[]

Response

200 - application/json

results

object[]

required

Show child attributes

count

integer

Example:

123

string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"

Create Letter

⌘I

List Letters

curl --request GET \
  --url https://sandbox.elationemr.com/api/2.0/letters/ \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "patient": 123,
      "practice": 123,
      "send_to_contact": {
        "id": 123,
        "first_name": "<string>",
        "last_name": "<string>",
        "middle_name": "<string>",
        "npi": "<string>",
        "org_name": "<string>",
        "specialties": [
          "<unknown>"
        ]
      },
      "attachments": [
        {
          "entity_date": "2023-11-07T05:31:56Z",
          "entity_description": "<string>",
          "entity_id": 123,
          "entity_type": 123,
          "handout": 123,
          "id": 123,
          "summary": "<string>"
        }
      ],
      "body": "<string>",
      "created_date": "2023-11-07T05:31:56Z",
      "deleted_date": "2023-11-07T05:31:56Z",
      "delivery_date": "2023-11-07T05:31:56Z",
      "direct_message_status": "<string>",
      "direct_message_to": "<string>",
      "display_to": "<string>",
      "document_date": "2023-11-07T05:31:56Z",
      "email_to": "<string>",
      "failure_unacknowledged": "<string>",
      "fax_attachments": true,
      "fax_status": "<string>",
      "fax_to": "<string>",
      "id": 123,
      "is_processed": true,
      "letter_type": "<string>",
      "referral_order": 123,
      "send_out": true,
      "send_to_elation_user": 123,
      "send_to_name": "<string>",
      "sign_date": "2023-11-07T05:31:56Z",
      "signed_by": 123,
      "subject": "<string>",
      "tags": [
        123
      ],
      "to_number": "<string>",
      "viewed_at": "2023-11-07T05:31:56Z",
      "with_archive": true
    }
  ],
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}