---
title: "List customers"
method: GET
path: "/v1/customers"
tags: ["Customers"]
---

# List customers

`GET /v1/customers`

## Query parameters

- `PageIndex` integer
- `PageSize` integer
- `OrderBy` string
- `query` 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
  - `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'

---

[API](https://skmtc.net/altoviz/apis/altoviz-api.md) · [All operations](https://skmtc.net/altoviz/apis/altoviz-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/altoviz/altoviz-api/versions/af5aae7365c9/schema)