GET

/v1/templates

http://pinpoint.{region}.amazonaws.com/v1/templates

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

Access Token Required: API Key

Query Params

next-tokenstring

The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

page-sizestring

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

prefixstring

The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

template-typestring

The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://pinpoint.{region}.amazonaws.com/v1/templates' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}