Skip to content

Get SMS template details

GET
/v1/sms-templates/{id}
curl --request GET \
--url https://api2.recruso.co.uk/v1/sms-templates/1 \
--header 'Authorization: <Authorization>'

Returns one of your agency’s SMS templates by id. Recruso sends SMS and WhatsApp messages on your agency’s behalf, and a template saves writing the same message every time.

You only ever see and change your own agency’s records; there is no owner id on the request, and an id belonging to another agency returns 404 rather than 403 so that its existence is never disclosed.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

id
required
integer format: int32

The id path parameter

OK

Media typeapplication/json
object
templateId
integer format: int32
templateName
string
templateDescription
string
nullable
createdBy

The Recruso user who created the template. SMS templates are your agency’s own content rather than something Recruso supplies, which is why they are audited.

integer format: int16
createdOn

When the template was created.

string format: date-time
modifiedBy

The Recruso user who last changed the template. Null until it is first changed.

integer format: int16
nullable
modifiedOn

When the template was last changed. Null until it is first changed.

string format: date-time
nullable
Examplegenerated
{
"templateId": 1,
"templateName": "example",
"templateDescription": "example",
"createdBy": 1,
"createdOn": "2026-04-15T12:00:00Z",
"modifiedBy": 1,
"modifiedOn": "2026-04-15T12:00:00Z"
}

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}