# API Key List

Retrieve a list of all API Keys and their configuration settings. API Keys are used as credentials to access the API and SMTP server.

Endpoint: GET /v3/REST/apikey
Version: 1.0.0
Security: basicAuth

## Query parameters:

  - `APIKey` (string)
    Retrieves the selected API Key.

  - `IsActive` (boolean)
    When true, only active API Keys will be retrieved. When false, active API Keys will be excluded from the result.

  - `IsMaster` (boolean)
    When true, only the Primary API Key will be retrieved. When false, the Primary API Key will be excluded from the result.

  - `Name` (string)
    Retrieves the API Key with the specified name.

## Response 200 fields (application/json):

  - `Count` (integer)
    Indicates the number of objects in the Data array.

  - `Data` (array)
    A JSON array containing a list of objects returned by this endpoint.

  - `Data.APIKey` (string)
    The unique alphanumeric API Key itself.

  - `Data.CreatedAt` (string)
    Timestamp indicating when the API Key was created.

  - `Data.ID` (integer)
    Unique numeric ID for this API Key.

  - `Data.IsMaster` (boolean)
    Indicates whether this is the Primary API Key or not.

  - `Data.Name` (string)
    Unique user-selected name for this API Key.

  - `Data.QuarantineValue` (integer)
    Indicates the sending limitation applied on this API Key in terms of messages per hour, when the API Key is under quarantine. 0 means no limitation is applied.

  - `Data.Runlevel` (object)
    Runlevel, used to indicate data is migrated and reduced performance is expected..

Possible values:

- Normal
- Softlock
- Hardlock

Default value: Normal

  - `Data.SecretKey` (string)
    The unique alphanumeric Secret Key (password) linked to this API Key.

  - `Data.TrackHost` (string)
    Host to be used when tracking clicks, opens, unsubscribe requests for this API Key.

Default value: r.mailjet.com

  - `Data.UserID` (integer)
    User ID. The Primary API Key and all sub-account API Keys will have the same user ID.

  - `Data.ACL` (string)
    Access Control List. Indicates permissions attached to a resource.

  - `Data.IsActive` (boolean)
    Indicates whether this API Key is active or not.

  - `Data.Skipspamd` (boolean)
    Deprecated property.

  - `Total` (integer)
    Indicates the number of objects in the Data array.


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 429 fields

## Response 500 fields