v1

latestOpenAPI 3.0.3“Commons Clause” License Condition v1.02026-07-17231343.3 KB
templates

List templates

Returns a list of templates in a paginated manner. Each object in the collection represents a Template. This endpoint should always return a result even if there are zero templates in the collection.

get/templates

Query parameters

per_pageinteger

Number of objects to be returned, per page.

ending_beforestring

ending_before is the ID of the object that should be included in order to fetch the previous page of the list, which ends before this object's place in the collection.

starting_afterstring

starting_after is the ID of the object that should be included in order to fetch the next page of the list, which begins after this object's place in the collection.

scopesobject

Scopes can be used to search through and filter a collection of results.

Response

OK

per_pageinteger

Number of objects that are present in the collection.

totalinteger

Total number of objects.

Example response

{
  "per_page": 15,
  "total": 100,
  "collection": [
    {
      "id": 111,
      "name": "HelloWorld",
      "subject_part": "Hello World!",
      "created_at": "2021-05-19T20:48:50.378Z",
      "updated_at": "2021-05-19T20:48:50.378Z"
    },
    {
      "id": 222,
      "name": "Welcome",
      "subject_part": "Welcome to Mailbadger {{name}}!",
      "created_at": "2021-05-19T20:48:50.378Z",
      "updated_at": "2021-05-19T20:48:50.378Z"
    }
  ]
}
All 23 operations