JSON API » outgroups » outgroups/list

Gets array of fields of outbound groups.

Input parameters

Requires authentication and the administrator, commerce, or reports role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes if customer is specified.
auth_password	String	Authentication password.	Yes if customer is specified.
count	Integer	1 to return a count, 0 to return full data.	No	0
pages	Integer	1 to return a reduced set of data for generating the pages select box, 0 to return full data.	No	0
search	String	Only return outbound groups whose name contains this string. Empty string for all.	No	Empty string.

Responses

Code	Description
200	Success.
400	Invalid search string specified.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

An array of fields, corresponding to the rows of the outgroups table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/outgroups/list/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"example1", ... }, { "id":2, "name":"example2", ... } ] }

Change history

Version	Changes
3.13	Function added.