Read All Templates

GET {{apiPath}}/environments/{{envID}}/templates

The GET /environments/{{envID}}/templates endpoint returns a list of all notifications template resources for the specified environment resource.

RESPONSES

status: OK

{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"next":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates?cursor=strong_authentication"}},"_embedded":{"templates":[{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates/general"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"general","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"description":"Use this multi-purpose template to create custom notifications.","deliveryMethods":["SMS","Email","Voice"],"displayName":"General","createdAt":"2022-07-10T13:53:48.000Z","updatedAt":"2022-07-10T13:53:48.000Z","allowDynamicVariables":true},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates/id_verification"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"id_verification","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"description":"Users will receive this message, which contains instructions for providing identity documents.","deliveryMethods":["SMS","Email"],"displayName":"PingOne Verify ID Verification","createdAt":"2022-04-13T14:17:46.027Z","updatedAt":"2022-04-13T14:17:46.027Z","variables":{"user.username":{"required":false},"user.name.given":{"required":false},"user.name.family":{"required":false},"app.open.url":{"required":true,"requiredForDeliveryMethods":["SMS","Email"]}},"allowDynamicVariables":true},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates/transaction"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"transaction","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"description":"Users will receive this message for transaction approval.","deliveryMethods":["SMS","Email","Push","Voice"],"displayName":"Transaction","createdAt":"2020-03-18T09:42:00.705Z","updatedAt":"2020-03-18T09:42:00.705Z","variables":{"user.username":{"required":false},"user.name.given":{"required":false},"user.name.family":{"required":false},"otp":{"required":true,"requiredForDeliveryMethods":["SMS","Email","Voice"]}},"allowDynamicVariables":true},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates/verification_code_template"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"verification_code_template","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"description":"Users will receive this message to verify their email address.","deliveryMethods":["Email"],"displayName":"Verification Code","createdAt":"2019-01-10T16:39:56.000Z","updatedAt":"2019-01-10T16:39:56.000Z","variables":{"user.username":{"required":false},"user.name.given":{"required":false},"user.name.family":{"required":false},"code.value":{"required":true,"requiredForDeliveryMethods":["Email"]}},"allowDynamicVariables":true},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates/recovery_code_template"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"recovery_code_template","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"description":"Users who need to reset their password will receive this message.","deliveryMethods":["Email"],"displayName":"Password Recovery","createdAt":"2019-01-10T16:39:56.000Z","updatedAt":"2019-01-10T16:39:56.000Z","variables":{"user.username":{"required":false},"user.name.given":{"required":false},"user.name.family":{"required":false},"code.value":{"required":true,"requiredForDeliveryMethods":["Email"]}},"allowDynamicVariables":true},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates/device_pairing"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"device_pairing","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"description":"Users will receive this message to pair their device for strong authentication.","deliveryMethods":["SMS","Email","Voice"],"displayName":"Device Pairing","createdAt":"2018-12-17T13:34:36.000Z","updatedAt":"2018-12-17T13:34:36.000Z","variables":{"user.username":{"required":false},"user.name.given":{"required":false},"user.name.family":{"required":false},"otp":{"required":true,"requiredForDeliveryMethods":["SMS","Email","Voice"]}},"allowDynamicVariables":true},{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates/strong_authentication"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"strong_authentication","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"description":"Users will receive this message for strong authentication.","deliveryMethods":["SMS","Email","Push","Voice"],"displayName":"Strong Authentication","createdAt":"2018-12-10T10:45:05.000Z","updatedAt":"2018-12-10T10:45:05.000Z","variables":{"user.username":{"required":false},"user.name.given":{"required":false},"user.name.family":{"required":false},"otp":{"required":true,"requiredForDeliveryMethods":["SMS","Email","Voice"]}},"allowDynamicVariables":true}]},"count":8,"size":7}