JSON API » mailboxes » mailboxes/list

Gets the fields of all mailboxes visible to the user in the given customer.

Input parameters

Requires authentication and the features, residential, or user role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
customer	Integer	ID of customer to get mailboxes for.	No	Customer of authentication user.

Responses

Code	Description
200	Success.
400	Invalid customer 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 mailboxes table in the database.

Example: With required parameters

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "mailbox":"1234", "customer":2, ... }, { "mailbox":"1235", "customer":2, ... } ] }

Change history

Version	Changes
3.13	Function added.