Organizations

Get organization sub accounts

get

Get a list of sub accounts for the specified organization. You must have sub account management permissions for this organization.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

organization_idinteger · int64 · min: 1Required

Unique organization ID

Example: 1001

Responses

200

Returns the list of sub accounts belonging to the organization.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

get

/api/organizations/{organization_id}/sub_accounts

cURL

curl -X GET https://mailtrap.io/api/organizations/{organization_id}/sub_accounts \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

[
  {
    "id": 12345,
    "name": "Development Team Account"
  },
  {
    "id": 12346,
    "name": "QA Team Account"
  }
]

Create organization sub account

post

Create a new sub account under the specified organization. You must have sub account management permissions for this organization.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

organization_idinteger · int64 · min: 1Required

Unique organization ID

Example: 1001

Body

application/json

Responses

200

Sub account created successfully.

application/json

400

Bad request - invalid parameters.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

422

Unprocessable entity - validation errors.

application/json

post

/api/organizations/{organization_id}/sub_accounts

cURL

curl -X POST https://mailtrap.io/api/organizations/{organization_id}/sub_accounts \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "account": {
      "name": "New Team Account"
    }
  }'

{
  "id": 12347,
  "name": "New Team Account"
}