Docs
Templates

List templates

List warmup templates (derived ACTIVE status, labels, mailbox counts, inbox rate)

GET
/v2/workspaces/{workspaceId}/templates

Path Parameters

workspaceIdnumber

Query Parameters

status?string

Displayed status. READY means ready but unused; ACTIVE means ready and matched to a mailbox.

Value in"DRAFT" | "REVIEWING" | "NEEDS_CONFIRMATION" | "READY" | "DELAYED" | "ACTIVE" | "REJECTED"
labelId?number

Only templates carrying this label.

page?number
Default1
Range1 <= value
pageSize?number
Default25
Range1 <= value <= 100

Response Body

curl -X GET "https://lynx-api.trulyinbox.com/v2/workspaces/0/templates?status=DRAFT&labelId=0&page=1&pageSize=25"
{
  "data": {
    "items": [
      {
        "id": 0,
        "name": "string",
        "subject": "string",
        "status": "DRAFT",
        "labels": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "ownerName": "string",
        "createdByUserId": 0,
        "mailboxCount": 0,
        "statusReason": "string",
        "updatedAt": "string",
        "statusChangedAt": "string"
      }
    ],
    "total": 0
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "details": {},
    "retry_after": 34
  },
  "meta": {
    "request_id": "req_2f1c…",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}