• Overview
  • Examples
  • Recipes
  • Commerce Modules
  • Architectural Modules
  • Integrations
  • Storefront Development
    • SDKs and Tools
    • create-medusa-app
    • Medusa CLI
    • JS SDK
    • Next.js Starter Storefront
    General
    • Medusa Configurations
    • Deployment Guides
    • Troubleshooting Guides
    Admin
    • Admin Widget Injection Zones
    • Admin Components
    Lists
    • Container Dependencies
    • Events List
    References
    • Workflows SDK
    • Data Model Language
    • Service Factory
    • Helper Steps
    • Core Workflows
    • Testing Framework
    Other
    • Contribution Guidelines
      • Docs
      • Admin Translations
    • Usage
  • Get Started
  • Product
    Commerce Modules
    Architectural Modules
  • Resources
    Guides
    Examples
    Recipes
    Admin Components
    Storefront Development
    UI Library
  • Tools & SDKs
    Medusa CLI
    JS SDK
    Next.js Starter
    create-medusa-app
    Integrations
  • Framework
    Modules
    API Routes
    Workflows
    Data Models
    Subscribers
    Scheduled Jobs
    Loaders
    Admin Customizations
    Links
    Query
  • Reference
    Admin API
    Store API
    Core Workflows
    Data Model Language
    Service Factory
    Events Reference
    Admin Widget Injection Zones
v2.2·Report Issue
Homepage
Medusa v1
Changelog
Troubleshooting
Hide Sidebar⌘\
Theme
Light
Dark
Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

ApiKeyDTO

The API key details.

Loading...
Was this page helpful?
Edit this page
      Guides
      • All Areas
      • Guides
      • References
      • Admin API (v2)
      • Store API (v2)
      • Medusa UI
      Navigation↑↓
      Open Result↵
      idstring
      The ID of the API key.
      tokenstring
      The token of the API key.
      redactedstring
      The redacted form of the API key's token. This is useful when showing portion of the token. For example sk_...123.
      titlestring
      The title of the API key.
      typeApiKeyType
      The type of the API key.
      last_used_atnull | Date
      The date the API key was last used.
      created_bystring
      Who created the API key.
      created_atDate
      The date the API key was created.
      updated_atDate
      The date the API key was updated.
      deleted_atnull | Date
      The date the API key was deleted.
      revoked_bynull | string
      Who revoked the API key. For example, the ID of the user that revoked it.
      revoked_atnull | Date
      The date the API key was revoked.