Clerk Platform Api — Applications

naftiko: 1.0.0-alpha2
info:
  label: Clerk Platform Api — Applications
  description: 'Clerk Applications capability. 11 operations. Lead operation: List Applications.'
  tags:
  - Clerk
  - Applications
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    CLERK_PARTNER_KEY: CLERK_PARTNER_KEY
capability:
  consumes:
  - type: http
    namespace: clerk-platform-api-applications
    baseUri: https://api.clerk.com/v1
    description: Clerk clerk-platform-api Applications business capability.
    resources:
    - name: platform-applications
      path: /platform/applications
      operations:
      - name: PlatformListApplications
        method: GET
        description: List Applications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include_secret_keys
          in: query
          type: boolean
          description: Whether to include secret keys in the response.
          required: false
      - name: PlatformCreateApplication
        method: POST
        description: Create an Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: platform-applications-applicationid
      path: /platform/applications/{applicationID}
      operations:
      - name: PlatformGetApplication
        method: GET
        description: Get an Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: include_secret_keys
          in: query
          type: boolean
          description: Whether to include secret keys in the response. If 'true', the response will include the secret keys for each instance.
          required: false
      - name: PlatformUpdateApplication
        method: PATCH
        description: Update an Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: PlatformDeleteApplication
        method: DELETE
        description: Delete an Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
    - name: platform-applications-applicationid-logo
      path: /platform/applications/{applicationID}/logo
      operations:
      - name: PlatformUploadApplicationLogo
        method: POST
        description: Upload Application Logo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: PlatformDeleteApplicationLogo
        method: DELETE
        description: Delete Application Logo
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
    - name: platform-applications-applicationid-favicon
      path: /platform/applications/{applicationID}/favicon
      operations:
      - name: PlatformUploadApplicationFavicon
        method: POST
        description: Upload Application Favicon
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: PlatformDeleteApplicationFavicon
        method: DELETE
        description: Delete Application Favicon
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
    - name: platform-applications-applicationid-instances-envorinsid-usage
      path: /platform/applications/{applicationID}/instances/{envOrInsID}/usage
      operations:
      - name: PlatformGetInstanceUsage
        method: GET
        description: Get Instance Usage
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: envOrInsID
          in: path
          type: string
          description: 'Environment type (e.g., "development", "production") or instance ID.

            '
          required: true
        - name: start
          in: query
          type: string
          description: 'Start of the date range for usage data in YYYY-MM-DD format.

            Both `start` and `end` must be provided together.

            When omitted, the current billing cycle is used.

            '
          required: false
        - name: end
          in: query
          type: string
          description: 'Inclusive end of the date range for usage data in YYYY-MM-DD format.

            Both `start` and `end` must be provided together.

            When omitted, the current billing cycle is used.

            '
          required: false
    - name: platform-accountless-applications-claim
      path: /platform/accountless_applications/claim
      operations:
      - name: PlatformClaimAccountlessApplication
        method: POST
        description: Claim an Accountless Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true