API KEYS

View API Keys

Changed on Nov 3, 2026

Retrieve a list of API keys on this account

post/api_keys/view

Request

Base URL
https://api.smtp2go.com/v3
Auth
- API key in header X-Smtp2go-Api-Key
- or HTTP bearer
TypeScript
https://skmtc.dev/smtp2go/apis/smtp2go-api-v3-0-4/docs/api_keys/view/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring

A full API key to retrieve the information for.

searchstring

A search keyword used to refine the results.

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here.

Response

Successfully retrieved API keys

request_idstring required

Example response

{
  "data": [
    {
      "api_key": "api-000000000000********************",
      "username": "api-000000000000",
      "custom_rate_limit": true,
      "custom_ratelimit_value": 123,
      "custom_ratelimit_period": "0:30:00",
      "default_ratelimit_period": "unlimited",
      "ippool": 1234
    }
  ],
  "request_id": "4b661d88-6b2d-11eb-8bb3-f23c92bb31d2"
}

Changes

Nov 3, 2026313dcf9dd255 Revision changes
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status

Operation history