Skip to content
API Reference/
/
Get All Templates

Get All Templates

Request

Get all templates, potentially filtered by businesses, locations, authors, ...

Security
X-API-KEY or Authorization
Query
querystring

Free text search that applies to title and message

tagsstring

The tags values you want templates for

minLastEditedstring

The min date of the last update of the template

maxLastEditedstring

The max date of the last update of the template

minTimesUsedinteger, (int64)

The min usage count you want templates for

maxTimesUsedinteger, (int64)

The max usage count you want templates for

createdBystring

The ids of authors you want templates for

businessesArray of integers, (int64)

The ids of businesses you want templates for

locationsstring

The ids of locations you want templates for

pageinteger, (int64)

Used for pagination. Page number we're interested in

sizeinteger, (int64)

Number of templates per page

sortstring

Name of the field we want to sort

directionstring

Use asc for ascending sort or desc for descending sort

curl -i -X GET \
  'https://uberall.com/api/templates?query=string&tags=string&minLastEdited=string&maxLastEdited=string&minTimesUsed=0&maxTimesUsed=0&createdBy=string&businesses=0&locations=string&page=0&size=0&sort=string&direction=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Templates 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

responseArray of objectsrequired

The actual response object of the response

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
      ]
    }
  ]
}