Get Endpoint by SID

This request returns data for an endpoint, targeted by secure ID.

get	/endpoints/{endpoint_sid}

Sample

A sample GET request to get an endpoint, targeted by secure ID:

curl -X GET \
'https://api.carrierx.com/core/v2/endpoints/473d1623-c615-4b43-ab4f-01cd5491c56b' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

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

{
    "addresses": [
        {
            "direction": "any",
            "dst_port": 5060,
            "ip": "1.1.2.13",
            "location_sid": null,
            "port": 5060,
            "priority": 0,
            "sip_password": null,
            "sip_username": null,
            "srtp": false,
            "transport": "udp"
        }
    ],
    "attributes": {},
    "capacity": 0,
    "cps_limit": null,
    "endpoint_sid": "473d1623-c615-4b43-ab4f-01cd5491c56b",
    "name": "my_third_party",
    "out_sip_password": null,
    "out_sip_username": null,
    "partner_sid": "ed437757-002d-4ecc-aa5a-efdf5e50dba0",
    "properties": {},
    "transformations": [],
    "type": "third_party",
    "voip_token": "0cac0ffe-fed4-4ee3-8212-e50659e28088"
}

This request is enabled for Field Filtering.

Required Scopes

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

• endpoints.manage
• endpoints.read

Path Arguments

Parameter	Data Type	Description
endpoint_sid required	string	The endpoint secure ID.

Query Arguments

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