orchestrator
2024.10
false
Orchestrator API guide
- Getting started
- Authentication
- Swagger definition
- Orchestrator APIs
- Alerts Requests
- Assets requests
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Permissions requests
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
- Platform Management APIs
- Get Message Template
- Update a Message Template
- Get Message Template by Name
Get Message Template by Name
API reference for retrieving message templates filtered by name via the Identity API.
Returns message templates, filtered by name.
API Endpoint
GET https://{yourDomain}/{organizationName}/identity/api/MessageTemplate
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'
Query Parameters
| Param | Data type | Description |
|---|---|---|
name | String | The name of the message template. |
Responses
200 OK
Returns the message templates filtered by their names.
{
"id": 0,
"name": "string",
"value": "string"
}
{
"id": 0,
"name": "string",
"value": "string"
}