---
title: "Device Graph"
method: GET
path: "/v2/ces/deviceGraph/{macaddress}"
tags: ["Device"]
---

# Device Graph

`GET /v2/ces/deviceGraph/{macaddress}`

## Request

- Base URL: `https://api.alianza.com`
- URL: `https://api.alianza.com/v2/ces/deviceGraph/{macaddress}`
- Auth: API key in header `X-AUTH-TOKEN`
- TypeScript: <https://skmtc.dev/alianza/apis/alianza-public-api/docs/v2/ces/deviceGraph/:macaddress/get.ts> (a function with typed inputs; its response is checked against the schema)

Use to search for a deviceGraph, which is defined as information about a specific physical phone interface, plus information about all of the phone numbers which ring that device.

## Path parameters

- `macaddress` string, required

## Query parameters

- `limited` boolean

## Response `200`

successful operation

- union
  - DeviceGraphLimited
    - `deviceTypeId` string
    - `accountId` string
    - `partitionId` string
    - `macAddress` string
    - `deviceName` string
    - `emergencyNumber` string
    - `faxEnabled` boolean
    - `lineNumber` integer
    - `userId` string
    - `sipUsername` string
    - `linetype` string
    - `telephoneNumbers` string[], required
  - DeviceGraphUnlimited
    - `deviceTypeId` string
    - `accountId` string
    - `partitionId` string
    - `macAddress` string
    - `deviceName` string
    - `emergencyNumber` string
    - `faxEnabled` boolean
    - `lineNumber` integer
    - `userId` string
    - `sipUsername` string
    - `linetype` string
    - `tnas` TelephoneNumberAccountV2X[], required
      - `phoneNumber` string
      - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'LINE_APPEARANCE' | 'LINE_HUNTGROUP' | 'TELEPHONE' | 'VFAX' | 'BUSINESS_LINE' | 'BUSINESS_LINE_HUNT_GROUP' | 'CALL_GROUP' | 'CALL_QUEUE' | 'AUTO_ATTENDANT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER': What kind of destination gets calls from this number.
      - `referenceId` string: The id of the destination which gets calls from this number. You can think of this as a variable refkey; what it points to depends on the referenceType.
      - `functionType` 'ELS' | 'TollFree' | 'TemporaryNumber' | 'SPTN'
      - `canAcceptSMS` boolean
      - `operationalStatus` 'ACTIVE' | 'STAGED'
      - `portId` string
      - `servicePackageType` 'Usage' | 'PrimaryLocalFlatRate' | 'PrimaryLocalAndDomesticLDFlatRate' | 'SecondaryLocalFlatRate' | 'SecondaryLocalAndDomesticLDFlatRate'
      - `accountId` string
      - `partitionId` string
      - `customerServiceRecord` CustomerServiceRecordX
        - `id` string
        - `firstName` string
        - `middleInitial` string
        - `lastName` string
        - `businessName` string
        - `streetNumber` string
        - `streetNumberSuffix` string
        - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
        - `streetName` string
        - `streetSuffix` string
        - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
        - `city` string
        - `state` string: A two-letter state abbreviation
        - `country` string: Alianza supports accounts in the USA and Canada.
        - `postalCode` string
        - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER'
        - `unit` string
        - `customerType` 'BUSINESS' | 'RESIDENTIAL'
        - `firstNameSecondary` string
        - `blockCustomerName` boolean
        - `customerName` string
      - `carrierStatus` 'ACTIVE' | 'ACTIVATION_ON_HOLD' | 'ACTIVATION_PENDING' | 'PORT_PENDING' | 'CANCEL_PORT' | 'CANCEL_PORT_EXPIDITED' | 'DELETE_PENDING' | 'DELETED' | 'CANCEL_PORT_COMPLETE' | 'PORT_REJECTED' | 'INVENTORY' | 'INVENTORY_CLAIMED' | 'COOLDOWN' | 'RECOVERED'
      - `orderVersion` string
      - `e911Address` E911AddressX
        - `id` string
        - `firstName` string
        - `middleInitial` string
        - `lastName` string
        - `businessName` string
        - `streetNumber` string
        - `streetNumberSuffix` string
        - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
        - `streetName` string
        - `streetSuffix` string
        - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
        - `city` string
        - `state` string
        - `country` string
        - `postalCode` string
        - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER'
        - `unit` string
        - `customerType` 'BUSINESS' | 'RESIDENTIAL'
        - `latitude` string: -90 through 90, 4-6 decimals
        - `longitude` string: -180 through 180, 4-6 decimals
        - `language` string: Optional, see /v2/ref/language for supported languages
      - `temporaryNumber` string
      - `directoryListing` DirectoryListingX
        - `listed` boolean
        - `type` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX': Indicates how a telephone number should be listed. <span hidden>For more information on the directory listing process, please refer <a href="directoryListing.html#overview">here</a></span>
        - `address` AddressX
          - `id` string
          - `firstName` string
          - `middleInitial` string
          - `lastName` string
          - `businessName` string
          - `streetNumber` string
          - `streetNumberSuffix` string
          - `preDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
          - `streetName` string
          - `streetSuffix` string
          - `postDirectional` '' | 'N' | 'NE' | 'E' | 'SE' | 'S' | 'SW' | 'W' | 'NW'
          - `city` string
          - `state` string: A two-letter state abbreviation
          - `country` string: Alianza supports accounts in USA and CAN
          - `postalCode` string
          - `secondaryLocationDescription` '' | 'APARTMENT' | 'BUILDING' | 'BASEMENT' | 'DEPARTMENT' | 'FLOOR' | 'FRONT' | 'HANGER' | 'KEY' | 'LOBBY' | 'LOT' | 'LOWER' | 'OFFICE' | 'PENTHOUSE' | 'PIER' | 'REAR' | 'ROOM' | 'SIDE' | 'SLIP' | 'SPACE' | 'SUITE' | 'STOP' | 'TRAILER' | 'UNIT' | 'UPPER'
          - `unit` string
      - `assignAsCallerId` boolean
      - `byotnCarrierId` string
      - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7': Default ringtype for this phone
      - `carrierId` string
      - `tollFree` boolean
      - `id` string
      - `tags` string[]: Optional tags for categorizing the telephone number (e.g., location, service type). Tags are stored as attributes in the Attribute Service. Format is lowercase with hyphens replacing spaces. Maximum 10 tags per number.

## Other responses

- `401`: Expired Auth Token
- `404`: Device not found

---

[API](https://skmtc.dev/alianza/apis/alianza-public-api.md) - [All operations](https://skmtc.dev/alianza/apis/alianza-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alianza/apis/alianza-public-api/revisions/7223246c352c?raw)