Skip to content

List SMS templates

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

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

The response is not paged.

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.

OK

Media typeapplication/json
object
smsTemplates
Array<object>
object
templateId
integer format: int32
templateName
string
templateDescription
string
nullable
Examplegenerated
{
"smsTemplates": [
{
"templateId": 1,
"templateName": "example",
"templateDescription": "example"
}
]
}

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