Skip to main content
POST
View all admin emails

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

id
integer
required

Admin ID from the route. The legacy controller also requires admin_id in the body and uses that body field for filtering.

Body

application/json
client_id
string
required

Client ID used by the delegated mailbox query. Validation rule: required.

Example:

"207"

admin_id
integer
required

Admin ID used for filtering emails; required by the legacy controller before it delegates to the shared mailbox query. Validation rule: required|numeric.

Example:

714

page
integer
required

1-indexed page number passed to Laravel pagination. Validation rule: required|numeric.

Example:

1

perpage
integer
required

Number of mailbox rows to return per page. Validation rule: required|numeric.

Example:

10

permissions
object
required

Decoded permissions object for the requesting admin group. The delegated mailbox query reads program permission keys such as program-1221 and group_all to decide which emails are visible.

Example:

Response

200 - application/json

Successful operation

emails
object[]

The list of emails

number
integer

The total number of emails

a_emails
object[]

The list of emails assigned to the admin

perpage
integer

The number of emails per page