Skip to main content

GetApiKeysResponseModel

statusboolean

Whether the request succeeded.

Example: true
messagestring

Human-readable description of the result.

Example: Getting API Keys success
api_keys object[]

API keys returned by the request.

  • Array [
  • idinteger

    Unique numeric identifier for the API key.

    Example: 3287
    namestring

    Name of the API key.

    Example: api-example-key
    descriptionstring

    Description of the API key.

    Example:
    keystring

    API key value used to authenticate API requests.

    Example: ********-****-****-****-********be9a
    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the API key was created.

    Example: 2026-05-06T16:04:09Z
  • ]
  • GetApiKeysResponseModel
    {
    "status": true,
    "message": "Getting API Keys success",
    "api_keys": [
    {
    "id": 3287,
    "name": "api-example-key",
    "description": "",
    "key": "********-****-****-****-********be9a",
    "created_at": "2026-05-06T16:04:09Z"
    }
    ]
    }