List transactional emails

Retrieve a list of your transactional emails.

GET /v1/transactional

List transactional emails

cURL

curl --request GET \
  --url https://app.loops.so/api/v1/transactional \
  --header 'Authorization: Bearer <token>'

Response

{
  "pagination": {
    "totalResults": 23,
    "returnedResults": 20,
    "perPage": 20,
    "totalPages": 2,
    "nextCursor": "clyo0q4wo01p59fsecyxqsh38",
    "nextPage": "https://app.loops.so/api/v1/transactional?cursor=clyo0q4wo01p59fsecyxqsh38&perPage=20"
  },
  "data": [
    {
      "id": "clfn0k1yg001imo0fdeqg30i8",
      "name": "Welcome email",
      "lastUpdated": "2023-11-06T17:48:07.249Z",
      "dataVariables": []
    },
    {
      "id": "cll42l54f20i1la0lfooe3z12",
      "name": "Sign up confirmation",
      "lastUpdated": "2025-02-02T02:56:28.845Z",
      "dataVariables": [
        "confirmationUrl"
      ]
    },
    {
      "id": "clw6rbuwp01rmeiyndm80155l",
      "name": "Invitation",
      "lastUpdated": "2024-05-14T19:02:52.000Z",
      "dataVariables": [
        "firstName",
        "lastName",
        "inviteLink"
      ]
    },
    ...
  ]
}

Request

Query parameters

perPage · string · default: 20

How many results to return in each request. Must be between 10 and 50.

cursor · string

A cursor, to return a specific page of results. Cursors can be found from the pagination.nextCursor value in each response.

Response

This endpoint will return a list of all published transactional emails in your account.

pagination · object

Show metadata

totalResults · number

Total results found.

returnedResults · number

The number of results returned in this response.

perPage · number

The maximum number of results requested.

totalPages · number

Total number of pages.

nextCursor · nullable string

The next cursor (for retrieving the next page of results using the cursor parameter), or null if there are no further pages.

nextPage · nullable string

The URL of the next page of results, or null if there are no further pages.

data · array

Hide properties

id · string

The transactional email’s ID.

name · string

The transactional email’s name.

lastUpdated · string

The date the email was last updated in ECMA-262 date-time format.

dataVariables · array

Data variables in the transactional email.

Response

{
  "pagination": {
    "totalResults": 23,
    "returnedResults": 20,
    "perPage": 20,
    "totalPages": 2,
    "nextCursor": "clyo0q4wo01p59fsecyxqsh38",
    "nextPage": "https://app.loops.so/api/v1/transactional?cursor=clyo0q4wo01p59fsecyxqsh38&perPage=20"
  },
  "data": [
    {
      "id": "clfn0k1yg001imo0fdeqg30i8",
      "name": "Welcome email",
      "lastUpdated": "2023-11-06T17:48:07.249Z",
      "dataVariables": []
    },
    {
      "id": "cll42l54f20i1la0lfooe3z12",
      "name": "Sign up confirmation",
      "lastUpdated": "2025-02-02T02:56:28.845Z",
      "dataVariables": [
        "confirmationUrl"
      ]
    },
    {
      "id": "clw6rbuwp01rmeiyndm80155l",
      "name": "Invitation",
      "lastUpdated": "2024-05-14T19:02:52.000Z",
      "dataVariables": [
        "firstName",
        "lastName",
        "inviteLink"
      ]
    },
    ...
  ]
}