---
title: "Get partition data"
method: GET
path: "/v2/partition/{partitionId}"
tags: ["Partition"]
---

# Get partition data

`GET /v2/partition/{partitionId}`

## Request

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

## Path parameters

- `partitionId` string, required

## Response `200`

Successful operation

- PartitionX
  - `id` string
  - `name` string
  - `status` 'ACTIVE' | 'ARCHIVED' | 'HIDDEN'
  - `customerServiceNumber` string
  - `parentId` string
  - `useAccountNumberDefault` boolean
  - `bypassVoicemailPINValidationFromDevice` boolean
  - `billingCode` string
  - `country` string
  - `languageTag` string
  - `reorderNotifications` string[]
  - `subPartitionIds` string[]
  - `useOwnCarrier` boolean
  - `availableInboundCarrierId` string[]
  - `defaultRoutePlanId` string, uuid
  - `tnDeleteCooldownDays` integer
  - `defaultTimeZone` 'US/Samoa' | 'US/Hawaii' | 'US/Alaska' | 'US/Pacific' | 'US/Arizona' | 'US/Mountain' | 'US/Central' | 'US/Eastern' | 'America/St_Thomas' | 'Canada/Pacific' | 'Canada/Mountain' | 'Canada/Central' | 'Canada/Eastern' | 'Canada/Atlantic' | 'Canada/Newfoundland'
  - `tempTnThreshold` integer
  - `serviceDialPlanRules` DialPlanRuleX[]
    - `partitionId` string
    - `mask` string
    - `actionType` 'TranslateAndReapplyDialPlan' | 'CallOutboundNumber' | 'CallCustomerServiceHuntGroup' | 'Callback' | 'CallForwardingAlways' | 'CallForwardingOnBusy' | 'CallForwardingOnNoAnswer' | 'CallForwardingOnUnregistered' | 'CallNonEmergencyServices' | 'CallPublicServices' | 'CallCanadaHealthServices' | 'CallerIdBlockManage' | 'EnterVoiceMail' | 'DirectToVoicemail' | 'CallWaitingEnable' | 'CallWaitingDisable' | 'AnonymousCallRejectEnable' | 'AnonymousCallRejectDisable' | 'AnonymousCallRejectWithInterceptEnable' | 'AnonymousCallRejectWithInterceptDisable' | 'SelectiveCallAcceptEnable' | 'SelectiveCallAcceptDisable' | 'SpecificCallerBlock' | 'SpecificCallerBlockWithIntercept' | 'SpecificCallerAllow' | 'SpecificCallerVipRing' | 'SpecificCallerForwardEnable' | 'AccountAnonymousCallRejectEnable' | 'AccountAnonymousCallRejectDisable' | 'AccountAnonymousCallRejectWithInterceptEnable' | 'AccountAnonymousCallRejectWithInterceptDisable' | 'AccountSelectiveCallAcceptEnable' | 'AccountSelectiveCallAcceptDisable' | 'AccountSpecificCallerBlock' | 'AccountSpecificCallerAllow' | 'AccountSpecificCallerBlockWithIntercept' | 'DoNotDisturbEnable' | 'DoNotDisturbDisable' | 'PickupInDirectory' | 'CallTrace' | 'ParkCall' | 'ParkCallRetrieval' | 'DirectedCallPickUp' | 'GroupPickup' | 'ReservedForHuntGroup' | 'GroupForwarding' | 'CallPull' | 'GroupLoginLogout'
    - `callNumber` string
    - `endingMinimumLength` integer
    - `endingMaximumLength` integer
    - `translationMacro` string
    - `disableCallerId` boolean
    - `callerIdVisibilityOverride` 'UseDestinationCallerIdEnabledSetting' | 'Blocked' | 'Unblocked'
    - `disableCallWaiting` boolean
    - `overwriteCallerIdNumber` string
    - `bypassAuthorization` boolean
    - `outboundNumberFunction` 'CUSTOMER_SERVICE' | 'DIRECTORY_ASSISTANCE' | 'EMERGENCY_SERVICES' | 'ESSENTIAL_COMMUNITY_SERVICES' | 'NONURGENT_MUNICIPAL_GOVERNMENT_SERVICES' | 'NONURGENT_TELEHEALTH_SERVICES' | 'OPERATOR' | 'SPEED_DIAL' | 'TELECOMMUNICATIONS_RELAY_SERVICE' | 'TRAFFIC_INFORMATION' | 'UNDERGROUND_PUBLIC_UTILITY_LOCATION'
    - `breakTranslation` boolean
    - `id` string
  - `mediaFriends` MediaFriendsX
    - `enabled` boolean
    - `host` string
    - `toNumber` string
  - `defaultSimpleDialingBehaviorType` 'SEVEN_DIGIT' | 'TEN_DIGIT' | 'OPEN_DIAL_PLAN' | 'DIAL_NINE_SEVEN_DIGIT' | 'DIAL_NINE_TEN_DIGIT' | 'OPEN_DIAL_PLAN_TEN_DIGIT'
  - `defaultAdvancedDialingBehaviorType` 'SEVEN_DIGIT' | 'TEN_DIGIT' | 'OPEN_DIAL_PLAN' | 'DIAL_NINE_SEVEN_DIGIT' | 'DIAL_NINE_TEN_DIGIT' | 'OPEN_DIAL_PLAN_TEN_DIGIT'
  - `defaultDirectoryListingType` 'ERROR' | 'LIST_PUBLISH' | 'LIST_NOT_PUBLISH' | 'NOT_LIST_NOT_PUBLISH' | 'PORTED' | 'COMPLEX'
  - `portPushDays` integer
  - `allowedDeviceTypes` string[]
  - `defaultHoldTimeoutSeconds` integer
  - `allowLoginByAccountNumber` boolean
  - `requiresDeviceInventory` boolean
  - `usesTrammellE911Verification` boolean
  - `showComplexListing` boolean
  - `defaultExtensionLength` integer
  - `autoAssignCallerId` boolean
  - `byotnCarrierId` string
  - `fraudAlertNotifications` string[]

## Other responses

- `400`: Invalid request parameters
- `401`: Unauthorized
- `404`: 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)