Get tool templates | Atlas

curl https://api.youratlas.com/v1/api/tools/templates \
     -H "api-key: <apiKey>" \
     -H "Content-Type: application/json"

[
  {
    "id": "tpl_9f8b7c6d-1234-4a56-8e9f-0a1b2c3d4e5f",
    "name": "Customer Feedback Survey",
    "description": "Template for sending automated customer feedback surveys via SMS.",
    "type": "survey",
    "categories": "[\"customer-engagement\", \"survey\", \"sms\"]",
    "templateSettings": "{\"maxResponses\":1000,\"responseTimeout\":72}",
    "placeholders": "[{\"name\":\"customerName\",\"type\":\"string\",\"required\":true},{\"name\":\"surveyLink\",\"type\":\"url\",\"required\":true}]",
    "version": "1.2.0",
    "isActive": true,
    "status": "Approved",
    "creatorName": "Jane Doe",
    "iconUrl": "https://cdn.youratlas.com/icons/survey-template.png",
    "documentationUrl": "https://docs.youratlas.com/templates/customer-feedback-survey",
    "documentation": "This template is designed to collect customer feedback through SMS surveys. Customize placeholders to personalize messages.",
    "group": "Engagement Tools",
    "purpose": "Collect customer feedback to improve service quality.",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z"
  }
]

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Response

Successful response

idstring

namestring

descriptionstring

typestring

categoriesstring

JSON array of category names

templateSettingsstring

JSON-serialized template settings

placeholdersstring

JSON array of placeholder field definitions

versionstring

isActiveboolean

statusenum

Allowed values:

creatorNamestring

iconUrlstringformat: "uri"

documentationUrlstringformat: "uri"

documentationstring

groupstring

purposestring

createdAtdatetime

updatedAtdatetime

Errors

500

Internal Server Error