Get all Text Replacements
GET/text-replacements
Retrieve a list of user's Text Replacements.
Request
Responses
- 200
A paginated list of Text Replacements.
Operation spec
{
"method": "get",
"path": "/text-replacements",
"operationId": "get-user-text-replacements",
"parameters": [
{
"name": "cursor",
"description": "The cursor you received in the next_cursor field to fetch the next page.",
"in": "query",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "limit",
"description": "The amount of objects to retrieve, between 1 and 100.",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"example": 10
}
},
{
"name": "order",
"description": "This flag is used to get results sorted in ascending or descending order.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"ASC",
"DESC"
],
"example": "DESC",
"default": "ASC"
}
}
],
"responses": {
"200": {
"description": "A paginated list of Text Replacements.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"description": "Text replacement is a concise abbreviation (`trigger`) that unfolds into a predefined, extended text (`replacement`) during dictation.",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the Text Replacement."
},
"trigger": {
"type": "string",
"description": "The text which, if present in the dictation, will be automatically replaced with the replacement text.",
"example": "Normal blood pressure"
},
"replacement": {
"type": "string",
"description": "The replacement text for this Text Replacement. If the Text Replacement's trigger is detected during dictation, this text will be automatically applied to the dictation result.",
"example": "- Blood Pressure: 120/80 mmHg — within normal limits.\\n- No orthostatic change detected."
}
},
"required": [
"id",
"trigger",
"replacement"
],
"title": "text_replacement"
}
},
"has_more": {
"type": "boolean",
"example": true
},
"next_cursor": {
"type": "string",
"nullable": true,
"description": "An opaque cursor to fetch the next page of the collection.",
"title": "next_cursor"
}
},
"required": [
"data",
"has_more"
]
}
}
}
}
}
}