ButterflyMX

ButterflyMX is a property-access technology company whose smart video intercoms, keypads, smart locks, elevator controls, vehicle-access readers, package rooms and front-desk stations are installed in more than 20,000 multifamily, commercial, gated-community, student-housing and senior-living buildings. Its public ButterflyMX API (v4) exposes the same access-control core to partners and property-technology platforms: buildings, units, tenants, access points, devices, access groups, permanent access tools (PINs and RFID tags), keychains and virtual keys for visitor passes, door-release requests for programmatic swipe-to-open, and access and video-call logs. Real-time delivery is handled by building- and tenant-scoped webhook integrations, and native iOS and Android SDKs add in-app video-call handling on top of the REST surface. Authorization is OAuth 2.0 authorization-code, issued by an OpenID-Connect-discoverable authorization server at accounts.butterflymx.com, with a full sandbox replica for pre-production testing.

ButterflyMX publishes 14 APIs on the APIs.io network, including Access groups API, Access Logs API, Access Points API, and 11 more. Tagged areas include access-control, physical-access, smart-intercom, proptech, and property-management.

The ButterflyMX catalog on APIs.io includes 1 event-driven AsyncAPI specification.

ButterflyMX’s developer surface includes documentation, API reference, getting-started guide, support, engineering blog, pricing, changelog, and 27 more developer resources.

🌐 Visit website 📡 Source on GitHub
56.5/100 strong ▬ flat Agent 44/100 agent ready Full breakdown ↓
scored 2026-08-12 · rubric v0.11.0
14 APIs 1 MCP Servers
access-controlphysical-accesssmart-intercomproptechproperty-managementmultifamilybuilding-automationvisitor-managementiotsmart-locksoauth2webhooks

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-12 · rubric v0.11.0
Composite quality — 56.5/100 · strong
Contract Quality 15.7 / 25
Developer Ergonomics 13.8 / 20
Commercial Clarity 10.5 / 20
Operational Transparency 5.8 / 13
Governance 1.4 / 12
Discoverability 9.3 / 10
Agent readiness — 44/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 0 / 10
MCP Server 12 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 0 / 7
Typed Event Surface 6 / 6
Agent Skills 5 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/butterflymx: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 14

Individual APIs this provider publishes, each with its own machine-readable definition.

ButterflyMX Access groups API

The Access groups API from ButterflyMX — 6 operation(s) for access groups.

ButterflyMX Access Logs API

The Access Logs API from ButterflyMX — 2 operation(s) for access logs.

ButterflyMX Access Points API

The Access Points API from ButterflyMX — 3 operation(s) for access points.

ButterflyMX Access Tools API

The Access Tools API from ButterflyMX — 5 operation(s) for access tools.

ButterflyMX Building Integrations API

The Building Integrations API from ButterflyMX — 2 operation(s) for building integrations.

ButterflyMX Buildings API

The Buildings API from ButterflyMX — 3 operation(s) for buildings.

ButterflyMX Calls API

The Calls API from ButterflyMX — 2 operation(s) for calls.

ButterflyMX Devices API

The Devices API from ButterflyMX — 2 operation(s) for devices.

ButterflyMX Door Release Requests API

The Door Release Requests API from ButterflyMX — 1 operation(s) for door release requests.

ButterflyMX Keychains API

The Keychains API from ButterflyMX — 6 operation(s) for keychains.

ButterflyMX Tenant Integrations API

The Tenant Integrations API from ButterflyMX — 2 operation(s) for tenant integrations.

ButterflyMX Tenants API

The Tenants API from ButterflyMX — 3 operation(s) for tenants.

ButterflyMX Units API

The Units API from ButterflyMX — 4 operation(s) for units.

ButterflyMX Virtual Keys API

The Virtual Keys API from ButterflyMX — 2 operation(s) for virtual keys.

Scroll for all 14

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

butterflymx-mcp.yml

MCP SERVER

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

Butterflymx Webhooks

ASYNCAPI

Security Posture 3

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Butterflymx Authentication

oauth2/apiKey · 2 schemes

SECURITY

Butterflymx Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Butterflymx Trust Center

trust center published

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Butterflymx Scopes

6 scopes · authorizationCode/clientCredentials

6 scopes

SCOPES

Resources

Get Started 4

Portal, sign-up, and the first successful call

DeveloperPortal
DeveloperPortal
 GettingStarted
GettingStarted
 Login
Login
 Sandbox
Sandbox

Documentation 2

Reference material describing how the API behaves

Documentation
Documentation
 APIReference
APIReference

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

MCPServer
MCPServer
 LLMsTxt
LLMsTxt
 WellKnown
WellKnown
 AgentSkill
AgentSkill

Design & Contract 6

Pagination, idempotency, versioning, errors, and events

Conventions
Conventions
 ErrorCatalog
ErrorCatalog
 Lifecycle
Lifecycle
 Conformance
Conformance
 DataModel
DataModel
 Webhooks
Webhooks

Build 3

SDKs, sample code, and the tooling you integrate with

GitHubOrganization
GitHubOrganization
 Packages
Packages
 SDKs
SDKs

Access & Security 5

Authentication, authorization, and security posture

TrustCenter
TrustCenter
 Authentication
Authentication
 OAuthScopes
OAuthScopes
 DomainSecurity
DomainSecurity
 TrustCenter
TrustCenter

Operate 4

Status, limits, changes, and where to get help

Support
Support
 StatusPage
StatusPage
 ChangeLog
ChangeLog
 ChangeLog
ChangeLog

Commercial 3

Pricing, plans, and the legal terms of use

Pricing
Pricing
 TermsOfService
TermsOfService
 PrivacyPolicy
PrivacyPolicy

Company 2

The organization behind the API

Website
Website
 Blog
Blog

Other 1

Properties that don't map to a standard resource type

Overlay
Overlay

Source (apis.yml)

apis.yml Raw ↑ 
aid: butterflymx
name: ButterflyMX
description: 'ButterflyMX is a property-access technology company whose smart video intercoms, keypads, smart locks, elevator
  controls, vehicle-access readers, package rooms and front-desk stations are installed in more than 20,000 multifamily, commercial,
  gated-community, student-housing and senior-living buildings. Its public ButterflyMX API (v4) exposes the same access-control
  core to partners and property-technology platforms: buildings, units, tenants, access points, devices, access groups, permanent
  access tools (PINs and RFID tags), keychains and virtual keys for visitor passes, door-release requests for programmatic
  swipe-to-open, and access and video-call logs. Real-time delivery is handled by building- and tenant-scoped webhook integrations,
  and native iOS and Android SDKs add in-app video-call handling on top of the REST surface. Authorization is OAuth 2.0 authorization-code,
  issued by an OpenID-Connect-discoverable authorization server at accounts.butterflymx.com, with a full sandbox replica for
  pre-production testing.'
image: https://butterflymx.com/wp-content/uploads/2023/10/gated-community-intercom.webp
url: https://raw.githubusercontent.com/api-evangelist/butterflymx/refs/heads/main/apis.yml
x-type: company
x-source: harvest:secondary-market
specificationVersion: '0.20'
created: '2026-08-08'
modified: '2026-08-08'
tags:
- access-control
- physical-access
- smart-intercom
- proptech
- property-management
- multifamily
- building-automation
- visitor-management
- iot
- smart-locks
- oauth2
- webhooks
apis:
- aid: butterflymx:butterflymx-access-groups-api
  name: ButterflyMX Access groups API
  description: The Access groups API from ButterflyMX — 6 operation(s) for access groups.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Access groups
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-access-groups-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-access-logs-api
  name: ButterflyMX Access Logs API
  description: The Access Logs API from ButterflyMX — 2 operation(s) for access logs.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Access Logs
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-access-logs-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-access-points-api
  name: ButterflyMX Access Points API
  description: The Access Points API from ButterflyMX — 3 operation(s) for access points.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Access Points
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-access-points-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-access-tools-api
  name: ButterflyMX Access Tools API
  description: The Access Tools API from ButterflyMX — 5 operation(s) for access tools.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Access Tools
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-access-tools-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-building-integrations-api
  name: ButterflyMX Building Integrations API
  description: The Building Integrations API from ButterflyMX — 2 operation(s) for building integrations.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Building Integrations
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-building-integrations-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-buildings-api
  name: ButterflyMX Buildings API
  description: The Buildings API from ButterflyMX — 3 operation(s) for buildings.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Buildings
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-buildings-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-calls-api
  name: ButterflyMX Calls API
  description: The Calls API from ButterflyMX — 2 operation(s) for calls.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Calls
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-calls-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-devices-api
  name: ButterflyMX Devices API
  description: The Devices API from ButterflyMX — 2 operation(s) for devices.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Devices
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-devices-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-door-release-requests-api
  name: ButterflyMX Door Release Requests API
  description: The Door Release Requests API from ButterflyMX — 1 operation(s) for door release requests.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Door Release Requests
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-door-release-requests-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-keychains-api
  name: ButterflyMX Keychains API
  description: The Keychains API from ButterflyMX — 6 operation(s) for keychains.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Keychains
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-keychains-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-tenant-integrations-api
  name: ButterflyMX Tenant Integrations API
  description: The Tenant Integrations API from ButterflyMX — 2 operation(s) for tenant integrations.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Tenant Integrations
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-tenant-integrations-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-tenants-api
  name: ButterflyMX Tenants API
  description: The Tenants API from ButterflyMX — 3 operation(s) for tenants.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Tenants
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-tenants-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-units-api
  name: ButterflyMX Units API
  description: The Units API from ButterflyMX — 4 operation(s) for units.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Units
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-units-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
- aid: butterflymx:butterflymx-virtual-keys-api
  name: ButterflyMX Virtual Keys API
  description: The Virtual Keys API from ButterflyMX — 2 operation(s) for virtual keys.
  humanURL: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  baseURL: https://api.butterflymx.com
  tags:
  - Virtual Keys
  properties:
  - type: OpenAPI
    url: openapi/butterflymx-virtual-keys-api-openapi.yml
  - type: Documentation
    url: https://apidocs.butterflymx.com/
  - type: APIReference
    url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
  - type: GettingStarted
    url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
  - type: Authentication
    url: authentication/butterflymx-authentication.yml
  - type: OAuthScopes
    url: scopes/butterflymx-scopes.yml
  - type: Conventions
    url: conventions/butterflymx-conventions.yml
  - type: ErrorCatalog
    url: errors/butterflymx-problem-types.yml
  - type: DataModel
    url: data-model/butterflymx-data-model.yml
  - type: Webhooks
    url: asyncapi/butterflymx-webhooks.yml
  - type: Sandbox
    url: sandbox/butterflymx-sandbox.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
- FN: APIs.json
  email: info@apis.io
common:
- type: MCPServer
  url: mcp/butterflymx-mcp.yml
- type: Overlay
  url: overlays/butterflymx-api-overlay.yaml
- type: Website
  url: https://butterflymx.com/
- type: DeveloperPortal
  url: https://apidocs.butterflymx.com/
- type: Documentation
  url: https://apidocs.butterflymx.com/
- type: APIReference
  url: https://apidocs.butterflymx.com/reference/get_v4-buildings-1
- type: GettingStarted
  url: https://apidocs.butterflymx.com/docs/getting-started-in-the-sandbox
- type: Support
  url: https://help.butterflymx.com/hc/en-us
- type: Blog
  url: https://butterflymx.com/blog/
- type: GitHubOrganization
  url: https://github.com/runslikebutter
- type: Pricing
  url: https://butterflymx.com/cost/
- type: Login
  url: https://accounts.butterflymx.com/login/new
- type: TermsOfService
  url: https://butterflymx.com/terms-of-service/
- type: PrivacyPolicy
  url: https://butterflymx.com/privacy-policy/
- type: StatusPage
  url: https://status.butterflymx.com/
- type: ChangeLog
  url: https://apidocs.butterflymx.com/changelog
- type: TrustCenter
  url: https://trust.butterflymx.com/
- type: LLMsTxt
  url: llms/butterflymx-llms.txt
- type: WellKnown
  url: well-known/butterflymx-well-known.yml
- type: Authentication
  url: authentication/butterflymx-authentication.yml
- type: OAuthScopes
  url: scopes/butterflymx-scopes.yml
- type: Conventions
  url: conventions/butterflymx-conventions.yml
- type: ErrorCatalog
  url: errors/butterflymx-problem-types.yml
- type: Lifecycle
  url: lifecycle/butterflymx-lifecycle.yml
- type: Conformance
  url: conformance/butterflymx-conformance.yml
- type: DomainSecurity
  url: security/butterflymx-domain-security.yml
- type: TrustCenter
  url: security/butterflymx-trust-center.yml
- type: Packages
  url: packages/butterflymx-packages.yml
- type: SDKs
  url: packages/butterflymx-packages.yml
- type: DataModel
  url: data-model/butterflymx-data-model.yml
- type: Webhooks
  url: asyncapi/butterflymx-webhooks.yml
- type: Sandbox
  url: sandbox/butterflymx-sandbox.yml
- type: ChangeLog
  url: changelog/butterflymx-changelog.yml
- type: AgentSkill
  url: skills/_index.yml
x-enrichment:
  date: '2026-08-08'
  status: enriched
  artifacts_added: 26
  pass: local-v1
x-coverage:
  state: covered
  reason: null
  detail: Full contract discovery succeeded. The provider's own OpenAPI 3.0.1 (43 paths / 57 operations) was harvested from
    apidocs.butterflymx.com, its llms.txt saved verbatim, and live OIDC + RFC 8414 discovery documents retrieved from accounts.butterflymx.com.
  evidence:
  - url: https://apidocs.butterflymx.com/llms.txt
    status: 200
  - url: https://accounts.butterflymx.com/.well-known/openid-configuration
    status: 200
  - url: https://api.butterflymx.com/
    status: 200
  checked: '2026-08-08'