Skip to navigation

List, Search or Filter Templates

GET https://api.beconversive.com/api/v2/templates

Returns a paginated list of the account’s templates, newest first. Use the query parameters to search and filter.

curl -G https://api.beconversive.com/api/v2/templates \
-H "apiKey: <API_KEY>" \
--data-urlencode "name=welcome" \
--data-urlencode "channel=sms,whatsapp" \
--data-urlencode "page=1"

200 Retrieved

{
"total_items": 1,
"page_number": 1,
"result": [
{
"id": 102031,
"name": "Welcome",
"template": "Hi, welcome!",
"channel": "sms",
"category": "TextOnly",
"modified_on": "2026-11-13T09:30:00Z"
}
]
}

Authentication

NameTypeRequiredDescription
apiKeystringRequiredAPI key authentication via header.

Query parameters

NameTypeRequiredDescription
namestringOptionalReturns templates whose name contains this text.
typestringOptionalautomation, campaign or conversation.
categorystringOptionalonly_text, media_message or rich_media.
channelstringOptionalsms, whatsapp, rcs, line, web, email or voice.
integrationstringOptionalIntegration name as saved on the template, e.g. hubspot.
labelstringOptionalLabel ID, or label name together with user_id.
created_bystringOptionalUser IDs. Use -1 for templates created by other users.
pageintegerOptionalPage number, starting at 1. Default 1.
page_sizeintegerOptionalResults per page, 10 to 1000. Default 10.

To filter by several values, separate them with commas, e.g. channel=sms,whatsapp.

Response

NameTypeDescription
total_itemsintegerTotal number of matching templates.
page_numberintegerPage returned.
resultlist of objectsMatching templates. See Get Template Detail for the template object.

Errors

StatusErrorDescription
400 Bad RequestMISSING-USER-ID-IN-REQUESTlabel was given as a name without user_id.
401 UnauthorizedNO-API-KEY / FORBIDDEN-API-KEYThe API key is missing or not valid.
403 Forbidden—More than 25 requests in a minute. Wait a minute and retry.