Skip to main content

Get RespOrg Details for Toll-Free Phone Number

This request returns RespOrg ID data for a specified toll-free phone number.

get /lookup/toll_free/{tollfree_phonenumber}

Sample​

A sample GET request to get a RespOrg ID for a specific toll-free phone number:

curl -X GET \
'https://api.carrierx.com/core/v2/lookup/toll_free/8002446227?resporg=true' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response​

200 status code with the RespOrg details:

{
    "cic": null,
    "resporg": "TZN99"
}

This request is enabled for Field Filtering.

Required Scopes​

To query the RespOrg information the partner must have the following scope enabled:

  • lookup.toll_free.allow_resporg to query a RespOrg's ID (using the resporg query argument set to true).
tip

Contact technical support at support@carrierx.com to enable this option.

Path Arguments​

ParameterData TypeDescription
tollfree_phonenumber requiredstringThe toll-free phone number to look up a RespOrg's ID for.

Query Arguments​

ParameterData TypeDescription
resporgbooleanDetermines if the RespOrg information should be shown in the response. Values accepted in this field are true and false. The default value is true. Returns null if set to false.
resporg_ttlintegerOverrides the default RespOrg cache TTL (in seconds).