Balladic

Balladic Admin API

The admin API from Balladic — 15 operation(s) for admin.

GitHub OpenAPI

Operations 18

GET /admin/stats/overview Stats Overview #
GET /admin/stats/user-growth Stats User Growth #
GET /admin/stats/active-users Stats Active Users #
GET /admin/stats/engagement Stats Engagement #
GET /admin/stats/conversions Stats Conversions #
GET /admin/users List Users #
GET /admin/codes List Codes #
POST /admin/codes Generate Codes #
DELETE /admin/codes/{code} Delete Code #
GET /admin/grants List Grants #
POST /admin/grants Create Grant #
DELETE /admin/grants/{code} Delete Grant #
GET /admin/announcements List Announcements #
POST /admin/announcements Create Announcement #
PUT /admin/announcements/{announcement_id} Update Announcement #
POST /admin/announcements/preview Preview Announcement #
POST /admin/announcements/{announcement_id}/test Test Announcement #
POST /admin/announcements/{announcement_id}/send Send Announcement #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/balladic-com/openapi/balladic-com-admin-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-project-list-item-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-project-detail-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-org-billing-status-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-task-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-notification-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/balladic-com/json-schema/balladic-com-user-response-schema.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/balladic-com/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/balladic-com:balladic-com-admin-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

balladic-com-admin-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Balladic Admin API
  description: Balladestreger
  version: 0.11.10
tags:
- name: Admin
paths:
  /admin/stats/overview:
    get:
      tags:
      - Admin
      summary: Stats Overview
      operationId: stats_overview_admin_stats_overview_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminOverview'
      security:
      - HTTPBearer: []
  /admin/stats/user-growth:
    get:
      tags:
      - Admin
      summary: Stats User Growth
      operationId: stats_user_growth_admin_stats_user_growth_get
      security:
      - HTTPBearer: []
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
          maximum: 365
          minimum: 1
          default: 90
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminUserGrowth'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/stats/active-users:
    get:
      tags:
      - Admin
      summary: Stats Active Users
      operationId: stats_active_users_admin_stats_active_users_get
      security:
      - HTTPBearer: []
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
          maximum: 365
          minimum: 1
          default: 90
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminActiveUsers'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/stats/engagement:
    get:
      tags:
      - Admin
      summary: Stats Engagement
      operationId: stats_engagement_admin_stats_engagement_get
      security:
      - HTTPBearer: []
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
          maximum: 365
          minimum: 1
          default: 90
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminEngagement'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/stats/conversions:
    get:
      tags:
      - Admin
      summary: Stats Conversions
      operationId: stats_conversions_admin_stats_conversions_get
      security:
      - HTTPBearer: []
      parameters:
      - name: days
        in: query
        required: false
        schema:
          type: integer
          maximum: 365
          minimum: 1
          default: 90
          title: Days
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminConversions'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/users:
    get:
      tags:
      - Admin
      summary: List Users
      operationId: list_users_admin_users_get
      security:
      - HTTPBearer: []
      parameters:
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Q
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminUsersResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/codes:
    get:
      tags:
      - Admin
      summary: List Codes
      operationId: list_codes_admin_codes_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AdminCodeRow'
                type: array
                title: Response List Codes Admin Codes Get
      security:
      - HTTPBearer: []
    post:
      tags:
      - Admin
      summary: Generate Codes
      operationId: generate_codes_admin_codes_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateCodesRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateCodesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /admin/codes/{code}:
    delete:
      tags:
      - Admin
      summary: Delete Code
      operationId: delete_code_admin_codes__code__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/grants:
    get:
      tags:
      - Admin
      summary: List Grants
      operationId: list_grants_admin_grants_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AdminGrantRow'
                type: array
                title: Response List Grants Admin Grants Get
      security:
      - HTTPBearer: []
    post:
      tags:
      - Admin
      summary: Create Grant
      operationId: create_grant_admin_grants_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGrantRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminGrantRow'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /admin/grants/{code}:
    delete:
      tags:
      - Admin
      summary: Delete Grant
      operationId: delete_grant_admin_grants__code__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
          title: Code
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/announcements:
    get:
      tags:
      - Admin
      summary: List Announcements
      operationId: list_announcements_admin_announcements_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementsResponse'
      security:
      - HTTPBearer: []
    post:
      tags:
      - Admin
      summary: Create Announcement
      operationId: create_announcement_admin_announcements_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnouncementRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementRow'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /admin/announcements/{announcement_id}:
    put:
      tags:
      - Admin
      summary: Update Announcement
      operationId: update_announcement_admin_announcements__announcement_id__put
      security:
      - HTTPBearer: []
      parameters:
      - name: announcement_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Announcement Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnouncementRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementRow'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/announcements/preview:
    post:
      tags:
      - Admin
      summary: Preview Announcement
      operationId: preview_announcement_admin_announcements_preview_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnnouncementRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementPreview'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /admin/announcements/{announcement_id}/test:
    post:
      tags:
      - Admin
      summary: Test Announcement
      operationId: test_announcement_admin_announcements__announcement_id__test_post
      security:
      - HTTPBearer: []
      parameters:
      - name: announcement_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Announcement Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /admin/announcements/{announcement_id}/send:
    post:
      tags:
      - Admin
      summary: Send Announcement
      description: starts or resumes the send; claims keep a resume from repeating anyone
      operationId: send_announcement_admin_announcements__announcement_id__send_post
      security:
      - HTTPBearer: []
      parameters:
      - name: announcement_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Announcement Id
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnnouncementRow'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AdminUserGrowth:
      properties:
        labels:
          items:
            type: string
          type: array
          title: Labels
        new_signups:
          items:
            type: integer
          type: array
          title: New Signups
        cumulative:
          items:
            type: integer
          type: array
          title: Cumulative
      type: object
      required:
      - labels
      - new_signups
      - cumulative
      title: AdminUserGrowth
    AdminUserRow:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        email:
          type: string
          title: Email
        name:
          type: string
          title: Name
        plan:
          type: string
          title: Plan
        created_at:
          type: string
          format: date-time
          title: Created At
        last_seen_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Seen At
        online:
          type: boolean
          title: Online
        project_count:
          type: integer
          title: Project Count
      type: object
      required:
      - id
      - email
      - name
      - plan
      - created_at
      - last_seen_at
      - online
      - project_count
      title: AdminUserRow
    AnnouncementsResponse:
      properties:
        audience:
          type: integer
          title: Audience
        items:
          items:
            $ref: '#/components/schemas/AnnouncementRow'
          type: array
          title: Items
      type: object
      required:
      - audience
      - items
      title: AnnouncementsResponse
    AdminOverview:
      properties:
        total_users:
          type: integer
          title: Total Users
        active_users:
          type: integer
          title: Active Users
        online_now:
          type: integer
          title: Online Now
        total_projects:
          type: integer
          title: Total Projects
        total_tasks:
          type: integer
          title: Total Tasks
        pro_users:
          type: integer
          title: Pro Users
        outstanding_codes:
          type: integer
          title: Outstanding Codes
      type: object
      required:
      - total_users
      - active_users
      - online_now
      - total_projects
      - total_tasks
      - pro_users
      - outstanding_codes
      title: AdminOverview
    AdminEngagement:
      properties:
        labels:
          items:
            type: string
          type: array
          title: Labels
        tasks:
          items:
            type: integer
          type: array
          title: Tasks
        projects:
          items:
            type: integer
          type: array
          title: Projects
        comments:
          items:
            type: integer
          type: array
          title: Comments
      type: object
      required:
      - labels
      - tasks
      - projects
      - comments
      title: AdminEngagement
    AnnouncementRequest:
      properties:
        subject:
          type: string
          maxLength: 200
          minLength: 1
          title: Subject
        preheader:
          type: string
          maxLength: 200
          title: Preheader
          default: ''
        body:
          type: string
          maxLength: 50000
          minLength: 1
          title: Body
        inactive_days:
          anyOf:
          - type: integer
            maximum: 365.0
            minimum: 1.0
          - type: 'null'
          title: Inactive Days
      type: object
      required:
      - subject
      - body
      title: AnnouncementRequest
    AdminActiveUsers:
      properties:
        labels:
          items:
            type: string
          type: array
          title: Labels
        values:
          items:
            type: integer
          type: array
          title: Values
      type: object
      required:
      - labels
      - values
      title: AdminActiveUsers
    AnnouncementPreview:
      properties:
        html:
          type: string
          title: Html
        audience:
          type: integer
          title: Audience
      type: object
      required:
      - html
      - audience
      title: AnnouncementPreview
    AdminConversions:
      properties:
        labels:
          items:
            type: string
          type: array
          title: Labels
        conversions:
          items:
            type: integer
          type: array
          title: Conversions
        redeemed_total:
          type: integer
          title: Redeemed Total
        unredeemed_total:
          type: integer
          title: Unredeemed Total
      type: object
      required:
      - labels
      - conversions
      - redeemed_total
      - unredeemed_total
      title: AdminConversions
    AdminGrantRow:
      properties:
        code:
          type: string
          title: Code
        title:
          type: string
          title: Title
        seats:
          type: integer
          title: Seats
        ballads:
          type: integer
          title: Ballads
        created_at:
          type: string
          format: date-time
          title: Created At
        redeemed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Redeemed At
        redeemed_org_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Redeemed Org Name
      type: object
      required:
      - code
      - title
      - seats
      - ballads
      - created_at
      - redeemed_at
      - redeemed_org_name
      title: AdminGrantRow
    AdminUsersResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AdminUserRow'
          type: array
          title: Items
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      required:
      - items
      - next_cursor
      title: AdminUsersResponse
    GenerateCodesResponse:
      properties:
        codes:
          items:
            type: string
          type: array
          title: Codes
      type: object
      required:
      - codes
      title: GenerateCodesResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CreateGrantRequest:
      properties:
        title:
          type: string
          maxLength: 200
          minLength: 1
          title: Title
        seats:
          type: integer
          minimum: 1.0
          title: Seats
        ballads:
          type: integer
          minimum: 0.0
          title: Ballads
        code:
          anyOf:
          - type: string
            maxLength: 6
            minLength: 1
          - type: 'null'
          title: Code
      type: object
      required:
      - title
      - seats
      - ballads
      title: CreateGrantRequest
    AdminCodeRow:
      properties:
        code:
          type: string
          title: Code
        created_at:
          type: string
          format: date-time
          title: Created At
        grant_days:
          anyOf:
          - type: integer
          - type: 'null'
          title: Grant Days
        max_uses:
          anyOf:
          - type: integer
          - type: 'null'
          title: Max Uses
        use_count:
          type: integer
          title: Use Count
      type: object
      required:
      - code
      - created_at
      - grant_days
      - max_uses
      - use_count
      title: AdminCodeRow
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AnnouncementRow:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        subject:
          type: string
          title: Subject
        preheader:
          type: string
          title: Preheader
        body:
          type: string
          title: Body
        inactive_days:
          anyOf:
          - type: integer
          - type: 'null'
          title: Inactive Days
        created_at:
          type: string
          format: date-time
          title: Created At
        sent_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Sent At
        recipients:
          anyOf:
          - type: integer
          - type: 'null'
          title: Recipients
        sending:
          type: boolean
          title: Sending
          default: false
      type: object
      required:
      - id
      - subject
      - preheader
      - body
      - inactive_days
      - created_at
      - sent_at
      - recipients
      title: AnnouncementRow
    GenerateCodesRequest:
      properties:
        count:
          type: integer
          maximum: 100.0
          minimum: 1.0
          title: Count
          default: 1
        code:
          anyOf:
          - type: string
            maxLength: 64
            minLength: 1
          - type: 'null'
          title: Code
        grant_days:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Grant Days
        max_uses:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Max Uses
      type: object
      title: GenerateCodesRequest
      description: bulk one-time codes (count) or a single custom promo code (code)
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer