Get Prefix by SID

This request returns data for a prefix, targeted by secure ID.

get	/phonenumber/prefixes/{prefix_sid}

Sample

A sample GET request to get the prefix, targeted by secure ID:

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/prefixes/cc367acb-94c8-418f-b247-85dce5806ef4' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a serialized copy of the Prefix object:

{
    "attributes": {},
    "callback_url": null,
    "lrn_sid": null,
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "prefix": "51625",
    "prefix_sid": "cc367acb-94c8-418f-b247-85dce5806ef4",
    "source_trunk_group_sid": null,
    "string_key_1": null,
    "string_key_2": null,
    "transformations": [],
    "trunk_group_sid": null
}

This request is enabled for Field Filtering.

Required Scopes

To get information about a Prefix object, the partner must have one of the following scopes enabled:

• phonenumber.manage
• phonenumber.read

Path Arguments

Parameter	Data Type	Description
prefix_sid required	string	The prefix secure ID.

Query Arguments

Parameter	Data Type	Description
with_related	boolean	Determines if the partner information related to the prefix should be shown. Values accepted in this field are true and false. The default value is false.