GetOTP Documentation

Templates

The Templates API provides a way to get your custom Templates.

Request for Templates API

To get your Templates, make a GET request to our Templates endpoint.

https://api.otp.dev/v1/templates

With the following Basic HTTP verification method:

Description	Required	Data Type	Example
Your API Key	Yes	String	mtbi2w4hlendfpxa1igthcu5p6mzxf7k

Note

Grab your API key from this page

With the following parameters:

Name	Description	Required	Data Type	Example
filter[status]	Status of the template	No	String	COMPLETED
filter[name]	Filter(Starts With) Templates by Name	No	String	My Template
page_size	The number of templates to return	No	String	10
page_token	Found in pagination links and can be used to get 'previous' or 'next' items	No	String

Note

Notes on the filter[status] parameter:

You can filter templates by status. Available statuses are: COMPLETED, IN_PROCESS, CANCELED.

Notes on the page_size parameter:

You can specify the number of templates to return. Defaults to 10, with a maximum of 1000.

Examples

Below is an example request using cURL:

curl --request GET \
    --url https://api.otp.dev/v1/templates \
    --header 'X-OTP-Key: {YOUR_API_KEY}' \
    --header 'accept: application/json'

The response would be a JSON structure, returned with HTTP 200 Codestatus code:

{
    "data": [
        {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "Template",
            "text": "Your code is {code}",
            "channel": "SMS",
            "status": "COMPLETED",
            "type": "text",
            "create_date": "2025-10-15T06:01:14.478Z",
            "update_date": "2025-10-15T06:01:14.478Z"
        }
    ],
    "pagination": {
        "number": 0,
        "size": 0,
        "total": 0,
        "links": {
            "first": "string",
            "current": "string",
            "previous": "string",
            "next": "string"
        }
    }
}

Response data details:

Name	Description	Data Type	Example
data[].id	The unique identifier of the template	String (UUID)	3fa85f64-5717-4562-b3fc-2c963f66afa6
data[].account_id	The unique identifier of the account	String (UUID)	3fa85f64-5717-4562-b3fc-2c963f66afa6
data[].name	The name of the template	String	My Template
data[].text	The text of the template	String	https://example.com
data[].channel	The channel of the template	String	1234567890
data[].status	The status of the template	String	DELIVERY
data[].type	The type of the template	String	My Webhook
data[].create_date	Creation date of the template in UTC, formatted as yyyy-mm-dd hh:mm:ss	String (datetime)	2025-09-24 07:09:20
data[].update_date	Updated date of the template in UTC, formatted as yyyy-mm-dd hh:mm:ss	String (datetime)	2025-09-24 07:09:20
pagination.number	Current page number	Integer	1
pagination.size	Requested page size	Integer	10
pagination.total	Total items available	Integer	11
pagination.links.first	URL of the first page	String (URL)	string
pagination.links.current	URL of the current page	String (URL)	string
pagination.links.previous	URL of the previous page	String (URL)	string
pagination.links.next	URL of the next page	String (URL)	string

If there is an error with the API call, you will receive a JSON response with 400+ status code, error code and message.

{
    "errors": [{
        "timestamp": "2025-08-18 00:00:00",
        "path": "/v1/templates",
        "method": "GET",
        "status": 400,
        "message": "'filter[channel]' value should be: [SMS, VIBER, WHATSAPP]",
        "code": "1257"
    }]
}

Please refer to this table for details:

Error Code	Description	HTTP Code
1257	'filter[channel]' value should be: [SMS, VIBER, WHATSAPP]	400