JSON API » peers » peers/get

Gets the fields of a peer.

Input parameters

Requires authentication and the user or commerce role privileges. If you do not have the system role privilege, only the id and name fields are returned.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of peer to get.	Yes
customer	Integer	ID of customer.	No	Customer of authentication user.
destination	Integer	1 to only return peer if customer can route to it, 0 for any.	No	0

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The peer does not exist, or you do not have permission to route to it.

Data returned

Fields of peer.

Example: With required parameters

http://enswitch.example.com/api/json/peers/get/?auth_username=user;auth_password=password;id=123

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123, "name":"example", ... } }

Change history

Version	Changes
3.13	Function added.