Skip to main content
GET
List telephone encounters
Returns telephone encounters synced from the EHR, newest first, with their status, assignee and actions. Use an encounter’s id to add an action with POST /telephone-encounters/actions.

Query Parameters

  • start_date (string, required): Start of the date range (YYYY-MM-DD, inclusive). Matches the encounter date in the EHR.
  • end_date (string, required): End of the date range (YYYY-MM-DD, inclusive).
  • patient_mrn (string, optional): Patient MRN.
  • assigned_to_ehr_id (string, optional): Assignee’s staff ehr_id from GET /staff.
  • assigned_to_name (string, optional): Assignee name as shown in the EHR, e.g. Smith, Alex. Case- and space-insensitive.
  • created_by (string, optional): Name of the user who created the encounter, as shown in the EHR. Case- and space-insensitive.
  • locked (string, optional): true for only addressed (locked) encounters, false for only open ones.
  • reason (string, optional): Keyword in the reason, case-insensitive.
  • page (integer, optional): Page number (default: 1).
  • page_size (integer, optional): Results per page, max 100 (default: 100).

Example Request

Example Response

Staying Up To Date

Subscribe to the telephone_encounter.updated sync event to hear when an encounter changes (addressed, reassigned, new actions or notes) without polling.

Status Codes

  • 200: Telephone encounters returned.
  • 400: Missing or invalid dates, an invalid filter value, or an invalid page / page_size.

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Query Parameters

start_date
string
required

Start of the date range (YYYY-MM-DD, inclusive), matched against the encounter date in the EHR.

Example:

"2026-03-15"

end_date
string
required

End of the date range (YYYY-MM-DD, inclusive).

Example:

"2026-03-20"

patient_mrn
string

Filter by patient Medical Record Number.

Example:

"12345"

assigned_to_ehr_id
string

Filter by assignee: a staff ehr_id from GET /v1/staff.

Example:

"staff-123"

assigned_to_name
string

Filter by assignee name as shown in the EHR (e.g. "Smith, Jane"), case- and space-insensitive.

Example:

"Smith, Alex"

created_by
string

Filter by the user who created the encounter, as shown in the EHR (e.g. "Smith, Jane"), case- and space-insensitive.

Example:

"Smith, Alex"

locked
enum<string>

"true" returns only addressed (locked) encounters; "false" only open ones.

Available options:
true,
false
Example:

"false"

reason
string

Filter by a keyword in the reason, case-insensitive.

Example:

"refill"

page
string

Page number (default 1).

Example:

"1"

page_size
string

Results per page (1-100, default 100).

Example:

"100"

Response

Telephone encounters for the account

success
boolean
required
Example:

true

telephone_encounters
object[]
required
Example:
pagination
object
required