JSON API » outgroups » outgroups/get

Gets the fields of an outbound group.

Input parameters

Requires authentication and the system or top lists role privileges.

Name	Type	Description	Required	Default value
id	Integer	ID of outbound group to get.	Yes

Responses

Code	Description
200	Success.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The outbound group does not exist.

Data returned

Fields of outbound group.

Example: With required parameters

http://enswitch.example.com/api/json/outgroups/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.