JSON API » ingroups » ingroups/list

Gets array of fields of all inbound groups.

Input parameters

Requires authentication and the administrator or reports role privileges if customer is specified, else authentication is not required.

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.
callerid	Integer	1 to return only inbound groups that can be used as callerid, 0 to return all.	No	0
callerid_location	Integer	1 to return only inbound groups that can be used as location callerid, 0 to return all. Only used if location callerid is configured.	No	0
count	Integer	1 to return only a count of the number of inbound groups. 0 for full list.	No	0
customer	Integer	ID of customer to get spare numbers for. Only used if ported=1 or spare=1.	No	Customer of authentication user.
descending	Integer	1 to sort descending, 0 not to.	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
ported	Integer	1 to return only inbound groups that allow porting of numbers in, 0 to return all.	No	0
signup	Integer	1 to return only inbound groups that can be used as signup, 0 to return all.	No	0
sort	String	Field to sort by. "description" or "name".	No	"name"
spare	Integer	1 to return only inbound groups that contain unused numbers, 0 to return all.	No	0

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
402	Your role does not allow this.

Data returned

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

Example: With required parameters

http://enswitch.example.com/api/json/ingroups/list/

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

Change history

Version	Changes
3.14	ported input parameter added.
3.13	Function added.