Skip to main content
GET
/
sub-account
/
{handle}
/
api-key
Retrieve Sub-account API Keys
curl --request GET \
  --url https://api.mailchannels.net/tx/v1/sub-account/{handle}/api-key \
  --header 'X-Api-Key: <x-api-key>'
[
  {
    "id": 123,
    "key": "<string>"
  }
]

Headers

X-Api-Key
string
required

Path Parameters

handle
string
required

Handle of the sub-account to retrieve the API key for.

Query Parameters

limit
integer
default:100

The maximum number of API keys to return. The default is 100.

Required range: 1 <= x <= 1000
offset
integer
default:0

The number of API keys to skip before returning results. The default is 0.

Required range: x >= 0

Response

Successfully retrieved the API key for the specified sub-account.

Maximum array length: 1000
id
integer

The API key ID for the sub-account.

key
string

API key for the sub-account.