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'