AhaSend · JSON Structure

Openapi V2 Api Key Structure

APIKey schema from AhaSend API

Type: object Properties: 10 Required: 8

EmailTransactional EmailDeveloper ToolsSMTPWebhooks

APIKey is a JSON Structure definition published by AhaSend, describing 10 properties, of which 8 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

object id created_at updated_at last_used_at account_id label public_key secret_key scopes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ahasend/refs/heads/main/json-structure/openapi-v2-api-key-structure.json",
  "name": "APIKey",
  "description": "APIKey schema from AhaSend API",
  "type": "object",
  "properties": {
    "object": {
      "type": "string",
      "enum": [
        "api_key"
      ],
      "description": "Object type identifier",
      "example": "api_key"
    },
    "id": {
      "type": "uuid",
      "description": "Unique identifier for the API key",
      "example": "500123"
    },
    "created_at": {
      "type": "datetime",
      "description": "When the API key was created",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated_at": {
      "type": "datetime",
      "description": "When the API key was last updated",
      "example": "2025-03-15T14:30:00Z"
    },
    "last_used_at": {
      "type": "datetime",
      "description": "When the API key was last used (updates every 5-10 minutes)",
      "example": "2025-03-15T14:30:00Z"
    },
    "account_id": {
      "type": "uuid",
      "description": "Account ID this API key belongs to",
      "example": "500123"
    },
    "label": {
      "type": "string",
      "description": "Human-readable label for the API key",
      "example": "example_value"
    },
    "public_key": {
      "type": "string",
      "description": "Public portion of the API key",
      "example": "aha-sk-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "secret_key": {
      "type": "string",
      "description": "Secret key (only returned on creation)",
      "example": "aha-sk-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    },
    "scopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/APIKeyScope"
      },
      "description": "Scopes granted to this API key",
      "example": [
        {
          "id": "500123",
          "created_at": "2025-03-15T14:30:00Z",
          "updated_at": "2025-03-15T14:30:00Z",
          "api_key_id": "500123",
          "scope": "example_value"
        }
      ]
    }
  },
  "required": [
    "object",
    "id",
    "created_at",
    "updated_at",
    "account_id",
    "label",
    "public_key",
    "scopes"
  ]
}