Get a single email

Get a specific Email from a specific Project

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

You can create and view your API Private Key here.

To retrieve the source language version of the email you can leave the language parameter empty. To retrieve a translation of the email you need to provide the language code in the language parameter.

You can also optionally provide a list of variables as an array of key:value pairs. The values that are provided will be substituted in your email where the variables are defined. The key is the variable name.

Try it

To test this endpoint using the Try It feature:

  1. Copy your Localize API Key into the Header field in the AUTHENTICATION section on the right.
  2. Fill in all required fields below, and any optional fields as needed.
  3. Click the Try it button.
  4. View the results and any error returns on the right side of the screen.

Feel free to copy the sample code provided on the right side of the screen into your source code project to get a start on using this endpoint.

Note that using the Try It feature will affect the data in your Localize dashboard!

You can find the language codes here in your dashboard.

Path Params
string
required
Defaults to PROJECT_KEY

Can be the Project Key or the Project ID

string
required

The email ID of the desired email.

Body Params
string

(optional) The language code for the language that you would like to retrieve. This can be the source language or a target language. The source langauge is returned by default.

variables
array

An optional array of "key:value" pairs for any variables that are in the source email.

variables
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!