---
title: "Account search"
method: GET
path: "/v2/partition/{partitionId}/account/search"
tags: ["Account"]
---

# Account search

`GET /v2/partition/{partitionId}/account/search`

## Request

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

Use to search for an account that contains the search term. The term is searched through the account number, account name, email addresses, phone numbers and devices MAC addresses, with no need to indicate which field should be searched.

## Path parameters

- `partitionId` string, required

## Query parameters

- `q` string

## Response `200`

Successful operation

- AccountViewX[]
  - `partitionId` string
  - `id` string
  - `accountNumber` string
  - `accountName` string
  - `type` 'SIMPLE' | 'ADVANCED'
  - `accountStatus` 'ACTIVE' | 'DISABLED' | 'DELETED' | 'DELETE_PENDING' | 'SUSPENDED' | 'PENDING'
  - `platformType` 'V2_0' | 'V2_1' | 'CPE1' | 'CPE2'
  - `platformChangeDate` integer
  - `matches` object

## 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)