---
title: "Find a customer"
method: GET
path: "/v1/customers/find"
tags: ["Customers"]
---

# Find a customer

`GET /v1/customers/find`

## Request

- Base URL: `https://api.altoviz.com`
- URL: `https://api.altoviz.com/v1/customers/find`
- Auth: none required
- TypeScript: <https://skmtc.dev/altoviz/apis/altoviz-api/docs/v1/customers/find/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `email` string
- `internalId` string
- `number` string

## Response `200`

OK

- Customer[]
  - `active` boolean: Active
  - `billingAddress` AddressFields
    - `city` string, nullable
    - `countryIso` string, nullable
    - `countryName` string, nullable
    - `formattedAddress` string, nullable
    - `inlineAddress` string, nullable
    - `street` string, nullable
    - `zipcode` string, nullable
  - `billingOptions` BillingOptions: Billing options
    - `allowed` boolean, nullable: Allowed
    - `bankAccountId` integer, nullable: Bank account ID
    - `buyerReference` string, nullable: Buyer reference
    - `colleagueId` integer, nullable: Colleague ID
    - `discount` Discount
      - `type` 'Percent' | 'Fixed'
      - `value` number, double
    - `initialCommitmentAmount` number, double, nullable: Intial commitment amount
    - `initialCommitmentDate` string, date, nullable: Initial commitment date
    - `initialCommitmentStatus` 'Unpaid' | 'Paid' | 'PartiallyPaid' | 'Balanced'
    - `liableToVat` boolean, nullable: Indicates whether the document is liable to VAT
    - `paymentMethod` 'Transfer' | 'Order' | 'Check' | 'Cash' | 'Card' | 'Bill' | 'Usec' | 'Other'
    - `sendDocumentAsAttachment` boolean, nullable: Send document as attachment
    - `settlementTermId` integer, nullable: Settlement term ID
    - `useTaxIncludedPrices` boolean, nullable: Use tax included prices
    - `vatReverseCharge` boolean, nullable: Indicates VAT should be included in sales
    - `vendorReference` string, nullable: Vendor reference. Used to be print on sales
  - `cellPhone` string, nullable: Cell phone number
  - `companyInformations` CompanyInfo
    - `effectiveElectronicAddress` string, nullable
    - `electronicAddress` string, nullable
    - `siret` string, nullable
    - `vatNumber` string, nullable
  - `companyName` string, nullable: Company name
  - `email` string, nullable: Email
  - `family` CustomerFamily: Customer family
    - `id` integer: ID
    - `internalId` string, nullable: Internal ID
    - `label` string, nullable: Label
    - `number` string, nullable: Number
  - `firstName` string, nullable: First name
  - `id` integer: Customer ID
  - `internalId` string, nullable: ID used in information system
  - `internalNotes` string, nullable: Internal notes
  - `lastName` string, nullable: Last name
  - `metadata` object, nullable: Metadata: free-form key/value pairs carried with the customer, for an integration to keep its own identifiers and flags against it. Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out keep whatever they held, and a key is removed only when you send it as `null`. Omitting the property entirely leaves the whole bag untouched, and `""` stores an empty value rather than removing the key.
  - `name` string, nullable: Name
  - `number` string, nullable: Number
  - `phone` string, nullable: Phone number
  - `shippingAddress` AddressFields
    - `city` string, nullable
    - `countryIso` string, nullable
    - `countryName` string, nullable
    - `formattedAddress` string, nullable
    - `inlineAddress` string, nullable
    - `street` string, nullable
    - `zipcode` string, nullable
  - `title` string, nullable: Title
  - `type` 'Business' | 'Consumer' | 'Government'

## Changes

- **2026-09-14** `4f7fa64cf9e3`: 1 info
  - added the optional property `items/metadata` to the response with the `200` status

[Operation history](https://skmtc.dev/altoviz/apis/altoviz-api/changes/v1/customers/find/get.md)

---

[API](https://skmtc.dev/altoviz/apis/altoviz-api.md) - [All operations](https://skmtc.dev/altoviz/apis/altoviz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/altoviz/apis/altoviz-api/revisions/4f7fa64cf9e3?raw)