PhoneController

Get phone numbers

List phone numbers for account

get/phone/numbers

Request

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

Query parameters

phoneCountry'US' | 'GB' | 'AU' | 'CA' | 'EE' | 'HK' | 'PL' | 'CH' | 'PT' | 'NL' | 'IL' | 'FI' | 'SE'

Optional phone country

lineTypestring

Optional line type filter

carrierNamestring

Optional carrier name filter

mobileCountryCodestring

Optional mobile country code filter

mobileNetworkCodestring

Optional mobile network code filter

providerLabelstring

Optional provider label filter such as T1 or T2

pageinteger

Optional page index for list pagination

sizeinteger

Optional page size for list pagination

sort'ASC' | 'DESC'

Optional createdAt sort direction ASC or DESC

sincestring date-time

Filter by created at after the given timestamp

beforestring date-time

Filter by created at before the given timestamp

searchstring

Optional search filter

tagstring[]

Optional tags to filter by. A phone must include all provided tags

includestring[]

Optional phoneIds to include in result

favouriteboolean

Optionally filter results for favourites only

Response

OK

Changes

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