ADT Sites API

openapi: 3.0.3
info:
  title: ADT Business Access Codes Sites API
  description: The ADT Business API provides commercial security management capabilities for managing multi-site security systems, access control, video surveillance, alarm monitoring, and security personnel management for small to enterprise business customers.
  version: '1'
  contact:
    name: ADT Business Support
    url: https://www.adt.com/business
  termsOfService: https://www.adt.com/terms-of-service
  license:
    name: ADT Terms of Service
    url: https://www.adt.com/terms-of-service
  x-generated-from: documentation
servers:
- url: https://api.adt.com/business/v1
  description: ADT Business API Production
security:
- oauth2: []
tags:
- name: Sites
  description: Manage business site security systems
paths:
  /sites:
    get:
      operationId: getSites
      summary: ADT List Business Sites
      description: Retrieve all business sites with security systems for the authenticated account.
      tags:
      - Sites
      parameters:
      - name: limit
        in: query
        description: Maximum number of sites to return.
        schema:
          type: integer
          default: 50
      - name: offset
        in: query
        description: Pagination offset.
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: List of business sites.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SiteList'
              examples:
                getSites200Example:
                  summary: Default getSites 200 response
                  x-microcks-default: true
                  value:
                    sites:
                    - id: site-001
                      name: Downtown Office
                      address: 456 Business Ave
                      status: armed
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                getSites401Example:
                  summary: Default getSites 401 response
                  x-microcks-default: true
                  value:
                    code: UNAUTHORIZED
                    message: Invalid credentials
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /sites/{siteId}:
    get:
      operationId: getSite
      summary: ADT Get a Business Site
      description: Retrieve details of a specific business site including security status and device inventory.
      tags:
      - Sites
      parameters:
      - name: siteId
        in: path
        required: true
        description: Unique identifier of the business site.
        schema:
          type: string
      responses:
        '200':
          description: Site details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Site'
              examples:
                getSite200Example:
                  summary: Default getSite 200 response
                  x-microcks-default: true
                  value:
                    id: site-001
                    name: Downtown Office
                    address: 456 Business Ave
                    status: armed
        '404':
          description: Site not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                getSite404Example:
                  summary: Default getSite 404 response
                  x-microcks-default: true
                  value:
                    code: NOT_FOUND
                    message: Site not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    SiteList:
      type: object
      description: List of business sites.
      properties:
        sites:
          type: array
          description: Array of business sites.
          items:
            $ref: '#/components/schemas/Site'
        total:
          type: integer
          description: Total number of sites.
          example: 5
    Site:
      type: object
      description: A business site with ADT security systems.
      properties:
        id:
          type: string
          description: Unique identifier of the site.
          example: site-001
        name:
          type: string
          description: Name of the business site.
          example: Downtown Office
        address:
          type: string
          description: Physical address.
          example: 456 Business Ave, Citytown, CA 90210
        status:
          type: string
          description: Current security status.
          enum:
          - armed
          - disarmed
          - alarm
          example: armed
        systemCount:
          type: integer
          description: Number of security systems at this site.
          example: 3
    ErrorResponse:
      type: object
      description: API error response.
      properties:
        code:
          type: string
          description: Error code.
          example: NOT_FOUND
        message:
          type: string
          description: Error message.
          example: The requested resource was not found.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.adt.com/oauth/token
          scopes:
            business:read: Read business site data
            business:write: Manage business security systems
            access-control:manage: Manage access control
            reports:read: Generate security reports
externalDocs:
  description: ADT Business Security Documentation
  url: https://www.adt.com/business