test-cloud
latest
false
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
Test Cloud API guide
Last updated Apr 7, 2026
Get Message Template
Returns a message template, based on the template ID.
API Endpoint
GET {accessURL}/{organizationName}/identity_/api/MessageTemplate/{templateId}
Replace {accessURL} in all endpoint paths with the base URL for your cloud platform:
| Cloud platform | Access URL |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud Public Sector | https://govcloud.uipath.us/ |
| Test Cloud Dedicated | https://{customURL}.dedicated.uipath.com/ |
Scopes
Requires the following scopes:
- PM.MessageTemplate
- PM.MessageTemplate.Read
Request Headers
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Path Parameters
| Path param | Data type | Description |
|---|---|---|
templateId (required) | String | The ID of message template you want to retrieve. |
Responses
200 OK
Returns the message template information, such as message ID, the message title, and the content.
{
"id": 0,
"name": "string",
"value": "string"
}
{
"id": 0,
"name": "string",
"value": "string"
}