JSON API » cards » cards/list

Gets the fields of all cards in a given group or batch.

Input parameters

Requires authentication and the cards role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
batch	Integer	ID of card batch to get cards for.	No
cardgroup	Integer	ID of card group to get cards for.	No
count	Integer	1 to return a count, 0 to return full data.	No	0
descending	Integer	1 to sort descending, 0 not to.	No	0
limit	Integer	The maximum results to return. 0 for all.	No	0
offset	Integer	The result to start at. 0 for the first.	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
sort	String	Field to sort by. "card", "created", "expires", "balance", "serial"	No	"card"

Either batch or cardgroup must be specified.

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 cardgroup or batch specified does not exist, or you do not have permission to view it.

Data returned

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

Example: With card group

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "card":"1234567890", ... }, { "card":"2345678901", ... } ] }

Change history

Version	Changes
3.13	Function added.