Retrieve a LinX Template

Retrieve details for a LinX template. The template ID and version information, statistics regarding the template use, and the workflow steps and related parameters are returned.

Endpoint

GET /v2/linx/templates/{templateId}

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

templateId REQUIRED

string (UUID)

ID of the LinX template. This ID is the same for all versions of the template.

Request Body

None

Returns

Returns the LinX Template Detail object. This object contains detailed information about the template, including the template ID and version information, statistics regarding the template use, and the workflow steps and related parameters.

SAMPLE RESPONSE

				
					{
  "templateId": "6746d9f8-eb72-45d3-81c9-d53f386d6ce3",
  "templateVersionId": "0e96b2ef-0642-4666-bc35-3c9e81eaf0b7",
  "version": 2,
  "name": "transaction-for-new-customer",
  "displayName": "Create a transaction for a new Customer",
  "description": "Create a new Customer and a new Financial Account, accept required documents, and create a transaction",
  "customerMemo": "Complete Your Purchase",
  "defaultExpiryDays": 2,
  "state": "ACTIVE",
  "stats": {
    "allVersionsActiveWorkflows": 2,
    "allVersionsWorkflows": 5,
    "allVersionsLastExecutedAt": "2024-02-01T23:38:06.437Z",
    "currentVersionActiveWorkflows": 1,
    "currentVersionWorkflows": 3,
    "currentVersionLastExecutedAt": "2024-02-01T23:38:06.437Z"
  },
  "steps": [
    {
      "name": "notification",
      "displayName": "Notification",
      "description": "Send notifications.",
      "input": {
        "preDefined": {
          "channel": "SMS",
          "introductoryMessage": "Please complete the following steps to set up your account and complete your purchase."
        }
      }
    },
    {
      "name": "customer-account",
      "displayName": "string",
      "description": "string",
    },
    {
      "name": "financial-account",
      "displayName": "string",
      "description": "string",
      "input": {
        "preDefined": {
          "financialAccountSubType": "CHECKING",
        }
      }
    },
    {
      "name": "document-acceptance",
      "displayName": "string",
      "description": "string",
      "input": {
        "user": {
          "documents": [
            {
              "documentId": "fncl-privacy-policy",
              "documentGroup": "rocket-financial"
            }
          ]
        }
     }
    },
    {
      "name": "move-money",
      "displayName": "Transaction Summary",
      "description": "Review and confirm your transaction summary.",
      "input": {
        "preDefined": {
          "transactionType": "REQUEST",
          "solution": "ACH",
          "currency": "USD",
          "priority": "IMMEDIATE",
          "paymentReasonId": "bill-payment"
        }
      }
    }
  ],
  "createdBy": {
    "id": "3f3e3100-95e6-48ec-bf51-dbba391a2942",
    "type": "employee"
  },
  "createdAt": "2024-02-01T23:38:06.437Z",
  "updatedBy": {
    "id": "3f3e3100-95e6-48ec-bf51-dbba391a2942",
    "type": "employee"
  },
  "updatedAt": "2024-02-01T23:38:06.437Z"
}