Get Phone Details

GET /phone/details

Gets the details for the given phone number. Returns the details if successful, otherwise returns an error.

Permissions Required: Phone::Lookup

Headers

  • x-number string

    The phone number to get the details for

Responses

  • 200 application/json

    The details for the given phone number

    Hide response attributes Show response attributes object

    The information that is returned when getting phone number information

    • status string Required

      The status of the phone number

    • phone string Required

      The phone number

    • phone_valid boolean Required

      Whether or not the phone number is valid

    • phone_type string Required

      The type of the phone number

    • phone_region string Required

      The region of the phone number

    • country string Required

      The country of the phone number

    • country_code string Required

      The country code of the phone number

    • country_prefix string Required

      The country prefix of the phone number

    • international_number string Required

      The international number of the phone number

    • local_number string Required

      The local number of the phone number

    • e164 string Required

      The E164 number of the phone number

    • carrier string Required

      The carrier of the phone number
  • 400 application/json

    Missing phone number information

    Hide response attributes Show response attributes object

    The error data that is returned when an error occurs

    All Error Codes are located in /functions/errorResponse.js GitHub

    • code integer Required

      The error code

      Minimum value is 0, maximum value is 30.

    • message string Required

      The error message
  • 401 application/json

    Invalid/Missing API Token

    Hide response attributes Show response attributes object

    The error data that is returned when an error occurs

    All Error Codes are located in /functions/errorResponse.js GitHub

    • code integer Required

      The error code

      Minimum value is 0, maximum value is 30.

    • message string Required

      The error message
  • 403 application/json

    Missing Permissions

    Hide response attributes Show response attributes object

    The error data that is returned when an error occurs

    All Error Codes are located in /functions/errorResponse.js GitHub

    • code integer Required

      The error code

      Minimum value is 0, maximum value is 30.

    • message string Required

      The error message
  • 404 application/json

    Error with the given phone number

    Hide response attributes Show response attributes object

    The error data that is returned when an error occurs

    All Error Codes are located in /functions/errorResponse.js GitHub

    • code integer Required

      The error code

      Minimum value is 0, maximum value is 30.

    • message string Required

      The error message
GET /phone/details 
curl \
 -X GET https://thefemdevs.com/api/phone/details \
 -H "x-number: +8888888888"
Response examples (200) 
{
  "e164": "+18888888888",
  "phone": "+8888888888",
  "status": "success",
  "carrier": "",
  "country": "United States",
  "phone_type": "fixed_line_or_mobile",
  "phone_valid": true,
  "country_code": "US",
  "local_number": "(888) 888-8888",
  "phone_region": "Michigan",
  "country_prefix": "1",
  "international_number": "+1 888-888-888"
}
Response examples (400) 
{
  "code": 8,
  "message": "Missing Header Parameter(s)"
}
{
  "code": 9,
  "message": "Invalid Header Parameter(s)"
}
Response examples (401) 
{
  "code": 3,
  "message": "No API key provided"
}
{
  "code": 4,
  "message": "Invalid API key provided"
}
Response examples (403) 
{
  "code": 1,
  "message": "You are not authorized to access this resource"
}
{
  "code": 2,
  "message": "You are blacklisted from accessing this resource"
}
Response examples (404) 
{
  "code": 22,
  "message": "Unable to retrieve requested information"
}