Medusa Api Keys API

openapi: 3.2.0
info:
  version: 2.19.0
  title: Medusa Admin Api Keys API
  license:
    name: MIT
    url: https://github.com/medusajs/medusa/blob/develop/LICENSE
  description: 'API keys can be used for authentication or resource-scoping.


    A secret API key can be used to authenticate admin users.  A publishable API key can be used to scope client requests to one or more sales channels.


    These API routes allow admin users to manage both publishable and secret API keys.

    '
servers:
- url: http://localhost:9000
- url: https://api.medusajs.com
tags:
- name: Api Keys
  description: 'API keys can be used for authentication or resource-scoping.


    A secret API key can be used to authenticate admin users.  A publishable API key can be used to scope client requests to one or more sales channels.


    These API routes allow admin users to manage both publishable and secret API keys.

    '
  externalDocs:
    description: Learn more about the API Key Module
    url: https://docs.medusajs.com/resources/commerce-modules/api-key
  x-associatedSchema:
    $ref: '#/components/schemas/AdminApiKey'
paths:
  /admin/api-keys:
    get:
      operationId: GetApiKeys
      summary: List API Keys
      description: Retrieve a list of API keys. The API keys can be filtered by fields such as `id`. The API keys can also be sorted or paginated.
      x-authenticated: true
      parameters:
      - name: fields
        in: query
        description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.
        required: false
        schema:
          type: string
          title: fields
          description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields.
          externalDocs:
            url: '#select-fields-and-relations'
      - name: offset
        in: query
        description: The number of items to skip when retrieving a list.
        required: false
        schema:
          type: number
          title: offset
          description: The number of items to skip when retrieving a list.
          externalDocs:
            url: '#pagination'
      - name: limit
        in: query
        description: Limit the number of items returned in the list.
        required: false
        schema:
          type: number
          title: limit
          description: Limit the number of items returned in the list.
          externalDocs:
            url: '#pagination'
      - name: order
        in: query
        description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
        required: false
        schema:
          type: string
          title: order
          description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
          externalDocs:
            url: '#pagination'
      - name: q
        in: query
        description: A search term to search the API keys' searchable properties.
        required: false
        schema:
          type: string
          title: q
          description: The search term.
      - name: id
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: id
            description: Filter by an API key's ID.
          - type: array
            description: Filter by API key IDs.
            items:
              type: string
              title: id
              description: The API key ID.
      - name: title
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: title
            description: Filter by an API key's title.
          - type: array
            description: Filter by API key titles.
            items:
              type: string
              title: title
              description: The API key title.
      - name: token
        in: query
        required: false
        schema:
          oneOf:
          - type: string
            title: token
            description: Filter by an API key's token.
          - type: array
            description: Filter by API key tokens.
            items:
              type: string
              title: token
              description: The API key token.
      - name: type
        in: query
        description: Filter by the API key's type.
        required: false
        schema:
          type: string
          enum:
          - secret
          - publishable
      - name: created_at
        in: query
        description: Filter by the API key's creation date.
        required: false
        schema:
          type: object
          description: Filter by the API key's creation date.
          properties:
            $and:
              type: array
              description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $and
            $or:
              type: array
              description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $or
            $eq:
              oneOf:
              - type: string
                title: $eq
                description: Filter by an exact match.
              - type: array
                description: Filter by multiple exact matches.
                items:
                  type: string
                  title: $eq
                  description: An exact match.
            $ne:
              type: string
              title: $ne
              description: Filter by values not equal to this parameter.
            $in:
              type: array
              description: Filter by values in this array.
              items:
                type: string
                title: $in
                description: The value to match.
            $nin:
              type: array
              description: Filter by values not in this array.
              items:
                type: string
                title: $nin
                description: The value not to match.
            $not:
              oneOf:
              - type: string
                title: $not
                description: Filter by values not matching this parameter.
              - type: object
                description: Filter by values not matching the conditions in this parameter.
                properties:
                  $and:
                    type: array
                    description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
                    items:
                      type: object
                    title: $and
                  $or:
                    type: array
                    description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
                    items:
                      type: object
                    title: $or
                  $eq:
                    oneOf:
                    - type: string
                      title: $eq
                      description: Filter by an exact match.
                    - type: array
                      description: Filter by multiple exact matches.
                      items:
                        type: string
                        title: $eq
                        description: The value to match.
                  $ne:
                    type: string
                    title: $ne
                    description: Filter by values not matching this parameter.
                  $in:
                    type: array
                    description: Filter by values in this array.
                    items:
                      type: string
                      title: $in
                      description: The value to match.
                  $nin:
                    type: array
                    description: Filter by values not in this array.
                    items:
                      type: string
                      title: $nin
                      description: The value to not match
                  $not:
                    oneOf:
                    - type: string
                      title: $not
                      description: Filter by values not matching this parameter
                    - type: object
                      description: Filter by values not matching the conditions in this parameter.
                    - type: array
                      description: Filter by values not matching the values of this parameter.
                      items:
                        type: string
                        title: $not
                        description: The values to not match.
                  $gt:
                    type: string
                    title: $gt
                    description: Filter by values greater than this parameter. Useful for numbers and dates only.
                  $gte:
                    type: string
                    title: $gte
                    description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
                  $lt:
                    type: string
                    title: $lt
                    description: Filter by values less than this parameter. Useful for numbers and dates only.
                  $lte:
                    type: string
                    title: $lte
                    description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
                  $like:
                    type: string
                    title: $like
                    description: Apply a `like` filter. Useful for strings only.
                  $re:
                    type: string
                    title: $re
                    description: Apply a regex filter. Useful for strings only.
                  $ilike:
                    type: string
                    title: $ilike
                    description: Apply a case-insensitive `like` filter. Useful for strings only.
                  $fulltext:
                    type: string
                    title: $fulltext
                    description: Filter to apply on full-text properties.
                  $overlap:
                    type: array
                    description: Filter arrays that have overlapping values with this parameter.
                    items:
                      type: string
                      title: $overlap
                      description: The value to match.
                  $contains:
                    type: array
                    description: Filter arrays that contain some of the values of this parameter.
                    items:
                      type: string
                      title: $contains
                      description: The values to match.
                  $contained:
                    type: array
                    description: Filter arrays that contain all values of this parameter.
                    items:
                      type: string
                      title: $contained
                      description: The values to match.
                  $exists:
                    type: boolean
                    title: $exists
                    description: Filter by whether a value for this parameter exists (not `null`).
              - type: array
                description: Filter by values not matching those in this parameter.
                items:
                  type: string
                  title: $not
                  description: The values to not match.
            $gt:
              type: string
              title: $gt
              description: Filter by values greater than this parameter. Useful for numbers and dates only.
            $gte:
              type: string
              title: $gte
              description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
            $lt:
              type: string
              title: $lt
              description: Filter by values less than this parameter. Useful for numbers and dates only.
            $lte:
              type: string
              title: $lte
              description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
            $like:
              type: string
              title: $like
              description: Apply a `like` filter. Useful for strings only.
            $re:
              type: string
              title: $re
              description: Apply a regex filter. Useful for strings only.
            $ilike:
              type: string
              title: $ilike
              description: Apply a case-insensitive `like` filter. Useful for strings only.
            $fulltext:
              type: string
              title: $fulltext
              description: Filter to apply on full-text properties.
            $overlap:
              type: array
              description: Filter arrays that have overlapping values with this parameter.
              items:
                type: string
                title: $overlap
                description: The values to match.
            $contains:
              type: array
              description: Filter arrays that contain some of the values of this parameter.
              items:
                type: string
                title: $contains
                description: The values to match.
            $contained:
              type: array
              description: Filter arrays that contain all values of this parameter.
              items:
                type: string
                title: $contained
                description: The values to match.
            $exists:
              type: boolean
              title: $exists
              description: Filter by whether a value for this parameter exists (not `null`).
          title: created_at
      - name: updated_at
        in: query
        description: Filter by the API key's update date.
        required: false
        schema:
          type: object
          description: Filter by the API key's update date.
          properties:
            $and:
              type: array
              description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $and
            $or:
              type: array
              description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $or
            $eq:
              oneOf:
              - type: string
                title: $eq
                description: Filter by an exact match.
              - type: array
                description: Filter by multiple exact matches.
                items:
                  type: string
                  title: $eq
                  description: An exact match.
            $ne:
              type: string
              title: $ne
              description: Filter by values not equal to this parameter.
            $in:
              type: array
              description: Filter by values in this array.
              items:
                type: string
                title: $in
                description: The value to match.
            $nin:
              type: array
              description: Filter by values not in this array.
              items:
                type: string
                title: $nin
                description: The value not to match.
            $not:
              oneOf:
              - type: string
                title: $not
                description: Filter by values not matching this parameter.
              - type: object
                description: Filter by values not matching the conditions in this parameter.
                properties:
                  $and:
                    type: array
                    description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
                    items:
                      type: object
                    title: $and
                  $or:
                    type: array
                    description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
                    items:
                      type: object
                    title: $or
                  $eq:
                    oneOf:
                    - type: string
                      title: $eq
                      description: Filter by an exact match.
                    - type: array
                      description: Filter by multiple exact matches.
                      items:
                        type: string
                        title: $eq
                        description: The value to match.
                  $ne:
                    type: string
                    title: $ne
                    description: Filter by values not matching this parameter.
                  $in:
                    type: array
                    description: Filter by values in this array.
                    items:
                      type: string
                      title: $in
                      description: The value to match.
                  $nin:
                    type: array
                    description: Filter by values not in this array.
                    items:
                      type: string
                      title: $nin
                      description: The value to not match
                  $not:
                    oneOf:
                    - type: string
                      title: $not
                      description: Filter by values not matching this parameter
                    - type: object
                      description: Filter by values not matching the conditions in this parameter.
                    - type: array
                      description: Filter by values not matching the values of this parameter.
                      items:
                        type: string
                        title: $not
                        description: The values to not match.
                  $gt:
                    type: string
                    title: $gt
                    description: Filter by values greater than this parameter. Useful for numbers and dates only.
                  $gte:
                    type: string
                    title: $gte
                    description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
                  $lt:
                    type: string
                    title: $lt
                    description: Filter by values less than this parameter. Useful for numbers and dates only.
                  $lte:
                    type: string
                    title: $lte
                    description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
                  $like:
                    type: string
                    title: $like
                    description: Apply a `like` filter. Useful for strings only.
                  $re:
                    type: string
                    title: $re
                    description: Apply a regex filter. Useful for strings only.
                  $ilike:
                    type: string
                    title: $ilike
                    description: Apply a case-insensitive `like` filter. Useful for strings only.
                  $fulltext:
                    type: string
                    title: $fulltext
                    description: Filter to apply on full-text properties.
                  $overlap:
                    type: array
                    description: Filter arrays that have overlapping values with this parameter.
                    items:
                      type: string
                      title: $overlap
                      description: The value to match.
                  $contains:
                    type: array
                    description: Filter arrays that contain some of the values of this parameter.
                    items:
                      type: string
                      title: $contains
                      description: The values to match.
                  $contained:
                    type: array
                    description: Filter arrays that contain all values of this parameter.
                    items:
                      type: string
                      title: $contained
                      description: The values to match.
                  $exists:
                    type: boolean
                    title: $exists
                    description: Filter by whether a value for this parameter exists (not `null`).
              - type: array
                description: Filter by values not matching those in this parameter.
                items:
                  type: string
                  title: $not
                  description: The values to not match.
            $gt:
              type: string
              title: $gt
              description: Filter by values greater than this parameter. Useful for numbers and dates only.
            $gte:
              type: string
              title: $gte
              description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
            $lt:
              type: string
              title: $lt
              description: Filter by values less than this parameter. Useful for numbers and dates only.
            $lte:
              type: string
              title: $lte
              description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
            $like:
              type: string
              title: $like
              description: Apply a `like` filter. Useful for strings only.
            $re:
              type: string
              title: $re
              description: Apply a regex filter. Useful for strings only.
            $ilike:
              type: string
              title: $ilike
              description: Apply a case-insensitive `like` filter. Useful for strings only.
            $fulltext:
              type: string
              title: $fulltext
              description: Filter to apply on full-text properties.
            $overlap:
              type: array
              description: Filter arrays that have overlapping values with this parameter.
              items:
                type: string
                title: $overlap
                description: The values to match.
            $contains:
              type: array
              description: Filter arrays that contain some of the values of this parameter.
              items:
                type: string
                title: $contains
                description: The values to match.
            $contained:
              type: array
              description: Filter arrays that contain all values of this parameter.
              items:
                type: string
                title: $contained
                description: The values to match.
            $exists:
              type: boolean
              title: $exists
              description: Filter by whether a value for this parameter exists (not `null`).
          title: updated_at
      - name: deleted_at
        in: query
        description: Filter by the API key's deletion date.
        required: false
        schema:
          type: object
          description: Filter by the API key's deletion date.
          properties:
            $and:
              type: array
              description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $and
            $or:
              type: array
              description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
              items:
                type: object
              title: $or
            $eq:
              oneOf:
              - type: string
                title: $eq
                description: Filter by an exact match.
              - type: array
                description: Filter by multiple exact matches.
                items:
                  type: string
                  title: $eq
                  description: An exact match.
            $ne:
              type: string
              title: $ne
              description: Filter by values not equal to this parameter.
            $in:
              type: array
              description: Filter by values in this array.
              items:
                type: string
                title: $in
                description: The value to match.
            $nin:
              type: array
              description: Filter by values not in this array.
              items:
                type: string
                title: $nin
                description: The value not to match.
            $not:
              oneOf:
              - type: string
                title: $not
                description: Filter by values not matching this parameter.
              - type: object
                description: Filter by values not matching the conditions in this parameter.
                properties:
                  $and:
                    type: array
                    description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
                    items:
                      type: object
                    title: $and
                  $or:
                    type: array
                    description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
                    items:
                      type: object
                    title: $or
                  $eq:
                    oneOf:
                    - type: string
                      title: $eq
                      description: Filter by an exact match.
                    - type: array
                      description: Filter by multiple exact matches.
                      items:
                        type: string
                        title: $eq
                        description: The value to match.
                  $ne:
                    type: string
                    title: $ne
                    description: Filter by values not matching this parameter.
                  $in:
                    type: array
                    description: Filter by values in this array.
                    items:
                      type: string
                      title: $in
                      description: The value to match.
                  $nin:
                    type: array
                    description: Filter by values not in this array.
                    items:
                      type: string
                      title: $nin
                      description: The value to not match
                  $not:
                    oneOf:
                    - type: string
                      title: $not
                      description: Filter by values not matching this parameter
                    - type: object
                      description: Filter by values not matching the conditions in this parameter.
                    - type: array
                      description: Filter by values not matching the values of this parameter.
                      items:
                        type: string
                        title: $not
                        description: The values to not match.
                  $gt:
                    type: string
                    title: $gt
                    description: Filter by values greater than this parameter. Useful for numbers and dates only.
                  $gte:
                    type: string
                    title: $gte
                    description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
                  $lt:
                    type: string
                    title: $lt
                    description: Filter by values less than this parameter. Useful for numbers and dates only.
                  $lte:
                    type: string
                    title: $lte
                    description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
                  $like:
                    type: string
                    title: $like
                    description: Apply a `like` filter. Useful for strings only.
                  $re:
                    type: string
                    title: $re
                    description: Apply a regex filter. Useful for strings only.
                  $ilike:
                    type: string
                    title: $ilike
                    description: Apply a case-insensitive `like` filter. Useful for strings only.
                  $fulltext:
                    type: string
                    title: $fulltext
                    description: Filter to apply on full-text properties.
                  $overlap:
                    type: array
                    description: Filter arrays that have overlapping values with this parameter.
                    items:
                      type: string
                      title: $overlap
                      description: The value to match.
                  $contains:
                    type: array
                    description: Filter arrays that contain some of the values of this parameter.
                    items:
                      type: string
                      title: $contains
                      description: The values to match.
                  $contained:
                    type: array
                    description: Filter arrays that contain all values of this parameter.
                    items:
                      type: string
                      title: $contained
                      description: The values to match.
                  $exists:
                    type: boolean
                    title: $exists
                    description: Filter by whether a value for this parameter exists (not `null`).
              - type: array
                description: Filter by values not matching those in this parameter.
                items:
                  type: string
                  title: $not
                  description: The values to not match.
            $gt:
              type: string
              title: $gt
              description: Filter by values greater than this parameter. Useful for numbers and dates only.
            $gte:
              type: string
              title: $gte
              description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
            $lt:
              type: string
              title: $lt
              description: Filter by values less than this parameter. Useful for numbers and dates only.
            $lte:
              type: string
              title: $lte
              description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
            $like:
              type: string
              title: $like
              description: Apply a `like` filter. Useful for strings only.
            $re:
              type: string
              title: $re
              description: Apply a regex filter. Useful for strings only.
            $ilike:
             

# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/medusa/refs/heads/main/openapi/medusa-api-keys-api-openapi.yml