SmsController

get/sms

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/sms
  • Auth: API key in header x-api-key

Query parameters

phoneNumberstring uuid

Optional receiving phone number to filter SMS messages for

pageinteger

Optional page index in SMS list pagination

sizeinteger

Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results

sort'ASC' | 'DESC'

Optional createdAt sort direction ASC or DESC

sincestring date-time

Optional filter SMSs received after given date time

beforestring date-time

Optional filter SMSs received before given date time

searchstring

Optional search filter

favouriteboolean

Optionally filter results for favourites only

includestring[]

Optional list of IDs to include in result

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.