Happyrobot

Happyrobot Use Cases API

The Use Cases API from Happyrobot — 1 operation(s) for use cases.

GitHub OpenAPI

Operations 3

GET /use-cases/ [Legacy] List use cases #
GET /use-cases Get use cases #
GET /use-cases/{use_case_id} Get a use case by ID #

Documentation

📖
Documentation
https://docs.happyrobot.ai/api-reference
📖
APIReference
https://docs.happyrobot.ai/api-reference
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/authentication/happyrobot-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/openapi/happyrobot-use-cases-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/conventions/happyrobot-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/errors/happyrobot-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/data-model/happyrobot-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/asyncapi/happyrobot-events.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/agentic-access/happyrobot-agentic-access.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/lifecycle/happyrobot-lifecycle.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/happyrobot-use-cases-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

happyrobot-use-cases-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Happyrobot Public Use Cases API
  description: Public API endpoints for Happyrobot
  version: 0.1.1
servers:
- url: https://platform.happyrobot.ai/api/v2
security:
- bearerAuth: []
tags:
- name: Use Cases
paths:
  /use-cases/:
    get:
      summary: '[Legacy] List use cases'
      tags:
      - Use Cases
      description: 'Returns use cases for the authenticated org along with the live production version if available (or the most recent version as fallback). **Deprecated**: prefer GET /workflows instead.'
      parameters:
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
        in: query
        name: is_deleted
        required: false
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
        in: query
        name: is_live
        required: false
      - schema:
          type: string
          enum:
          - 'true'
          - 'false'
        in: query
        name: is_published
        required: false
      deprecated: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    org_id:
                      type: string
                    name:
                      type: string
                    slug:
                      type: string
                    icon:
                      type:
                      - string
                      - 'null'
                    folder_id:
                      type:
                      - string
                      - 'null'
                    data_retention_days:
                      type:
                      - number
                      - 'null'
                    timestamp:
                      type: string
                    latest_version:
                      type:
                      - object
                      - 'null'
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        version_number:
                          type:
                          - number
                          - 'null'
                        is_published:
                          type: boolean
                        is_live:
                          type: boolean
                        environment:
                          type: string
                        published_at:
                          type:
                          - string
                          - 'null'
                        timestamp:
                          type: string
                      required:
                      - id
                      - name
                      - is_published
                      - is_live
                      - timestamp
                      additionalProperties: false
                  required:
                  - id
                  - org_id
                  - name
                  - slug
                  - timestamp
                  - latest_version
                  additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
      operationId: getUseCases
      x-operation-id-source: derived
  /use-cases:
    get:
      description: Get use cases for the organization
      summary: Get use cases
      tags:
      - Use Cases
      parameters:
      - name: authorization
        in: header
        required: true
        schema:
          type: string
          description: Your API key for authentication. Use Bearer format.
          example: Bearer API_KEY
      - name: x-organization-id
        in: header
        required: true
        schema:
          type: string
          description: The organization ID to use for the request. Required if your user is associated to more than one organization.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    org_id:
                      type: string
                      format: uuid
                    icon:
                      type: string
                      maxLength: 256
                    name:
                      type: string
                      maxLength: 256
                    source_use_case_version_id:
                      type:
                      - string
                      - 'null'
                      format: uuid
                    slug:
                      type: string
                      maxLength: 256
                    order:
                      type:
                      - number
                      - 'null'
                    run_columns:
                      type: array
                      items:
                        type: object
                        properties:
                          group_id:
                            type: string
                          variable_id:
                            type: string
                          name:
                            type: string
                        required:
                        - group_id
                        - variable_id
                    timestamp:
                      type: string
                      format: date-time
                    data_retention_days:
                      type:
                      - number
                      - 'null'
                    webhooks: {}
                    versions:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                          slug:
                            type: string
                            maxLength: 256
                          org_id:
                            type: string
                            format: uuid
                          use_case_id:
                            type: string
                            format: uuid
                          version_number:
                            type:
                            - number
                            - 'null'
                          name:
                            type: string
                            maxLength: 256
                          is_published:
                            type: boolean
                          is_live:
                            type: boolean
                          environment:
                            type: string
                            enum:
                            - staging
                            - production
                          source_version_id:
                            type:
                            - string
                            - 'null'
                            format: uuid
                          timestamp:
                            type: string
                            format: date-time
                          published_at:
                            type:
                            - string
                            - 'null'
                            format: date-time
                          is_deleted:
                            type: boolean
                          description:
                            type:
                            - string
                            - 'null'
                          created_by:
                            type:
                            - string
                            - 'null'
                            format: uuid
                        required:
                        - id
                        - slug
                        - org_id
                        - use_case_id
                        - version_number
                        - name
                        - is_published
                        - is_live
                        - environment
                        - source_version_id
                        - timestamp
                        - published_at
                        - is_deleted
                        - description
                        - created_by
                  required:
                  - id
                  - org_id
                  - icon
                  - name
                  - source_use_case_version_id
                  - slug
                  - order
                  - run_columns
                  - timestamp
                  - data_retention_days
                  - webhooks
                description: A list of use cases.
        '401':
          description: '401'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The user is not authenticated.
                required:
                - message
      operationId: getUseCases
      x-operation-id-source: derived
  /use-cases/{use_case_id}:
    get:
      description: Query a use case and it's details by ID
      summary: Get a use case by ID
      tags:
      - Use Cases
      parameters:
      - name: use_case_id
        in: path
        required: true
        schema:
          type: string
      - name: authorization
        in: header
        required: true
        schema:
          type: string
          description: Your API key for authentication. Use Bearer format.
          example: Bearer API_KEY
      - name: x-organization-id
        in: header
        required: true
        schema:
          type: string
          description: The organization ID to use for the request. Required if your user is associated to more than one organization.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  org_id:
                    type: string
                    format: uuid
                  icon:
                    type: string
                    maxLength: 256
                  name:
                    type: string
                    maxLength: 256
                  source_use_case_version_id:
                    type:
                    - string
                    - 'null'
                    format: uuid
                  slug:
                    type: string
                    maxLength: 256
                  order:
                    type:
                    - number
                    - 'null'
                  run_columns:
                    type: array
                    items:
                      type: object
                      properties:
                        group_id:
                          type: string
                        variable_id:
                          type: string
                        name:
                          type: string
                      required:
                      - group_id
                      - variable_id
                  timestamp:
                    type: string
                    format: date-time
                  data_retention_days:
                    type:
                    - number
                    - 'null'
                  webhooks: {}
                required:
                - id
                - org_id
                - icon
                - name
                - source_use_case_version_id
                - slug
                - order
                - run_columns
                - timestamp
                - data_retention_days
                - webhooks
                description: A use case.
        '401':
          description: '401'
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: The user is not authenticated.
                required:
                - message
      operationId: getUseCasesByUseCaseId
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque