Get all Dot Phrases

GET 
/dot_phrases

Retrieve a list of user's Dot Phrases.

Request

Query Parameters

cursor string

The cursor you received in the next_cursor field to fetch the next page.

limit integer

Possible values: >= 1 and <= 100

The amount of objects to retrieve, between 1 and 100.

order string
Possible values: [ASC, DESC]
This flag is used to get results sorted in ascending or descending order.
Default value: ASC

Responses

200

application/json

Schema

Schema

data

object[]

required

Array [

iduuidrequired

Unique identifier of the Dot Phrase.

titlestringrequired

A user-friendly title for the Dot Phrase. Does not impact the matching logic.

Example: Normal physical exam

triggerstringrequired

The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.

Example: Your physical exam is normal

content_auto_update_enabledbooleanrequired

If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.

Example: false

replacementstringrequired

The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.

Example: - Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly.

]

has_morebooleanrequired
Example: true
next_cursornext_cursor (string)nullable

An opaque cursor to fetch the next page of the collection.

Example (from schema)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Normal physical exam",
      "trigger": "Your physical exam is normal",
      "content_auto_update_enabled": false,
      "replacement": "- Heart Examination: Normal, with regular rate and rhythm, no murmurs. - Lung Assessment: Normal breath sounds, no wheezes, crackles, or rhonchi. - Abdominal Evaluation: Normal, no tenderness, masses, or hepatosplenomegaly."
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}