--- title: "Retrieve account by an ID." method: GET path: "/v2/partition/{partitionId}/account/{accountId}" tags: ["Account"] --- # Retrieve account by an ID. `GET /v2/partition/{partitionId}/account/{accountId}` ## Request - Base URL: `https://api.alianza.com` - URL: `https://api.alianza.com/v2/partition/{partitionId}/account/{accountId}` - Auth: API key in header `X-AUTH-TOKEN` - TypeScript: (a function with typed inputs; its response is checked against the schema) Though the accountId may be used to retrieve the account, it is not the only unique identifier for an account. Valid IDs are Id (accountId), AccountNumber, PhoneNumber, and MacAddress. Use the 'accountIdType' query parameter designate the ID type. ## Path parameters - `accountId` string, required - `partitionId` string, required ## Query parameters - `accountIdType` 'Id' | 'AccountNumber' | 'PhoneNumber' | 'MacAddress' ## Response `200` Successful operation - Account - `id` string, required: Required to update an account, not required for new account - `partitionId` string, required: A partitionId identifies the business entity that this account is a part of. Refers to partition.id - `accountNumber` string, required: The accountNumber is a string that uniquely identifies the account within a partition. AccountNumbers can be used to search for an account. - `accountName` string, required: The account name is a string that describes the account. The accountName is a field that can be used to identify the account in a search, though it is not required to be unique. - `billingCycleDay` integer, required: The day that marks the start of a billing cycle. Must be between 1 and 28. - `customField` string: Can be used to store generic data for the account. - `status` 'ACTIVE' | 'DISABLED' | 'DELETED' | 'DELETE_PENDING' | 'SUSPENDED' | 'PENDING', required: The status of the account within Alianza's system. Must be one of [ACTIVE,DISABLED,DELETED,DELETE_PENDING,SUSPENDED,PENDING] - `timeZone` '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', required: The IANA Time Zone Database (TZDB) zone id for the account. Must be a timezone for an area within Alianza's supported regions. - `languageTag` string - `deletionDate` string, date-time: ISO 8601 formatted date string of when the account was deleted. This is a deprecated field as deleted accounts are no longer retained. This field is present for backwards compatibility with old data. - `accountType` 'SIMPLE' | 'ADVANCED', required: The account type indicates whether the account supports only a single user (SIMPLE) or multiple users (ADVANCED). - `platformType` 'V2_0' | 'V2_1' | 'CPE1' | 'CPE2': The platform type indicates the features that are supported for the account. CPE1 supports the basic telephone features while CPE2 supports the business cloud communication features. PlatformTypes of V1_0 and V2_0 are deprecated and only present for backwards compatibility. - `platformChangeDate` string, date-time - `inboundRatePlanProductId` string: Identifies the inbound rate plan product for the account. This plan controls how toll free numbers are handled in the account. This field is only required for accounts with toll-free numbers. - `extensionLength` integer, required: Length of extension, not required for accounts with a SIMPLE accountType. - `dialingBehaviorType` 'SEVEN_DIGIT' | 'TEN_DIGIT' | 'OPEN_DIAL_PLAN' | 'DIAL_NINE_SEVEN_DIGIT' | 'DIAL_NINE_TEN_DIGIT' | 'OPEN_DIAL_PLAN_TEN_DIGIT', required: Defines how a user would be required to dial in order to place a call. For example, being required to dial 9 before placing a call. - `routePlanId` string, uuid: UUID of the route plan for this account. Route plans determine where outbound calls are routed and are created for a partition by Alianza. The routePlanId must be one that is available on the account's partition. All users on an account will share the same outbound route plan. - `callScreeningSettings` CallScreeningSettingsX - `anonymousCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `anonymousRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `tollFreeCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `tollFreeRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `defaultCallScreen` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `defaultRingType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `customCallScreenList` CustomCallScreenX[] - `telephoneNumber` string - `blockType` 'Allow' | 'Block' | 'Voicemail' | 'Forward' | 'VipRing' | 'BlockWithPrompt' - `ringType` 'StandardRing' | 'Ring1' | 'Ring2' | 'Ring3' | 'Ring4' | 'Ring5' | 'Ring6' | 'Ring7' - `forwardTn` string - `holdMusicMediaId` string: Id of the music file to be played when an inbound call is placed on hold. - `holdTimeoutSeconds` integer: Time in seconds before a call that has been placed on hold will be terminated. Does not apply to CPE1 platformTypes. - `allowDangerousExtensions` boolean: Allows extensions starting with 1 - `domain` string: Overrides the partition default branding which is used in the display of end user emails and the end user portal. - `sendWelcomeEmail` boolean: Specifies if new users added to the account will receive a welcome email. - `regulatoryType` 'RESIDENTIAL' | 'COMMERCIAL' | 'GOVERNMENT', required - `endUserCount` integer: Indicates the number of end users associated with this account. - `customHoldMusicMediaId` string - `callingPlans` CallingPlanX[] - `id` string - `referenceId` string - `referenceType` 'SIP_TRUNK' | 'END_USER' | 'IVR' | 'ACCOUNT' | 'SPECIALTY_LINE' | 'CONTACT_CENTER' - `callingPlanProductId` string - `endDate` string, date-time - `startDate` string, date-time - `planMinutes` integer - `secondsRemaining` integer ## Other responses - `400`: The supplied accountIdType parameter is malformed or not one of the valid options. - `401`: Unauthorized - `404`: Account 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)