Skip to navigation

Get Template Detail

GET https://api.beconversive.com/api/v2/templates?template_id={id}

Retrieves the full details of a single template. Get the ID from List templates or from the response to Create a template.

curl -G https://api.beconversive.com/api/v2/templates \
-H "apiKey: <API_KEY>" \
--data-urlencode "template_id=102031"

200 Retrieved

{
"total_items": 1,
"page_number": 1,
"result": [
{
"id": 102031,
"name": "Welcome",
"type_id_list": [1],
"template": "Hi, welcome!",
"channel": "sms",
"category": "TextOnly",
"crm_name": "hubspot",
"module": "contacts",
"label_id": null,
"content": null,
"template_folder_id": null,
"created_on": "2026-11-13T09:30:00Z",
"created_by": "jane.doe",
"modified_on": "2026-11-13T09:30:00Z",
"modified_by": "jane.doe",
"provider_template_details": null
}
]
}

Authentication

NameTypeRequiredDescription
apiKeystringRequiredAPI key authentication via header.

Query parameters

NameTypeRequiredDescription
template_idintegerRequiredID of the template to retrieve.

Response

NameTypeDescription
total_itemsintegerAlways 1 when the template is found.
page_numberintegerAlways 1.
resultlist of objectsThe template.

Template object

NameTypeDescription
idintegerUnique identifier for the template.
namestringTemplate name.
type_id_listarray of integersTemplate type IDs. The first is the primary type.
templatestringMessage text.
channelstringChannel, e.g. sms, whatsapp, rcs.
categorystringTextOnly, MediaMessage or RichMedia.
crm_namestringIntegration name.
modulestringIntegration record type.
label_idinteger or nullLabel ID.
contentobject or nullWhatsApp or RCS content.
template_folder_idinteger or nullFolder ID.
created_onstringCreation time (ISO 8601).
created_bystringUser who created the template.
modified_onstringLast-modified time (ISO 8601).
modified_bystringUser who last modified the template.
provider_template_detailsobject or nullChannel provider details: provider_name and template_status (e.g. WhatsApp approval status).

Errors

StatusErrorDescription
400 Bad Request—The request is missing a field or has a value that is not valid.
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.