Ampersand · JSON Structure

Ampersand Api Api Key Structure

ApiKey schema from Ampersand API

Type: object Properties: 5 Required: 4
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

ApiKey is a JSON Structure definition published by Ampersand, describing 5 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

key label scopes projectId active

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-api-key-structure.json",
  "name": "ApiKey",
  "description": "ApiKey schema from Ampersand API",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "The API key.",
      "example": "api-key-123"
    },
    "label": {
      "type": "string",
      "description": "A short name for the API key.",
      "example": "MailMonkey API Key"
    },
    "scopes": {
      "$ref": "#/components/schemas/ApiKeyScopes"
    },
    "projectId": {
      "type": "string",
      "description": "The project ID.",
      "example": "my-project"
    },
    "active": {
      "type": "boolean",
      "description": "Whether the API key is active.",
      "example": true
    }
  },
  "required": [
    "key",
    "projectId",
    "label",
    "scopes"
  ]
}