Skip to content
API Reference/
/
Get a Template

Get a Template

Request

Get all information about a specific template

Security
X-API-KEY or Authorization
Path
idstringrequired

The uberall unique id of the template

curl -i -X GET \
  'https://uberall.com/api/templates/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Template retrieved

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

Response Template Model

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {
    "id": 0,
    "title": "string",
    "message": "string",
    "usageCount": 0,
    "status": "string",
    "tags": [
      "string"
    ],
    "dateCreated": "2019-08-24T14:15:22Z",
    "lastEdited": "2019-08-24T14:15:22Z",
    "createdBy": {
      "id": 0,
      "firstname": "string",
      "lastname": "string"
    },
    "lastEditedBy": {
      "id": 0,
      "firstname": "string",
      "lastname": "string"
    },
    "businesses": [
      0
    ]
  }
}