# Get customers

Retrieves a paginated list of the customers for the specified locations and other matching parameters.

Endpoint: GET /customers
Security: BearerAuth

## Query parameters:

  - `companyId` (string, required)

  - `search` (string)
    Search by customer name, email or phone

  - `okForMarketing` (boolean)
    Filter customers based on whether they've opted for marketing updates or not

  - `updatedDateStart` (string)
    Filter by customer update date (start)

  - `updatedDateEnd` (string)
    Filter by customer update date (end)

  - `lastInvoiceDateStart` (string)

  - `lastInvoiceDateEnd` (string)

  - `sort` (string)

  - `customerType` (string)
    Filter by customer type. Accepts "regular" or "fleet"

  - `sortDirection` (string)
    Enum: "ASC", "DESC"

  - `size` (integer)

  - `page` (integer)

## Response 200 fields (application/json):

  - `content` (array)
    Example: [{"customerId":"CUST001","companyId":"98392","customerStatus":"Active","firstName":"John","lastName":"Doe","emails":[{"emailAddress":"john.doe@example.com","label":"Personal","primary":true,"active":true}],"phones":[{"number":"123-456-7890","label":"Work","type":"mobile","primary":true,"active":true}],"customerType":"Regular","communicationPreference":"email","notes":"VIP customer","mainAddress":{"address":"123 Main St","city":"New York","state":"NY","zip":"10001","country":"USA"},"taxExempt":false,"tags":[{"name":"VIP","color":"FFFF00"}],"chargeAccount":true,"preferredLocationID":"LOC123","languagePreference":"EN","okForMarketing":true,"createdDate":"2024-01-15T08:30:00Z","updatedDate":"2024-03-10T12:00:00Z"}]

  - `content.customerId` (string)

  - `content.companyId` (string)

  - `content.customerStatus` (string)

  - `content.firstName` (string)

  - `content.lastName` (string)

  - `content.emails` (array)
    Example: [{"emailAddress":"john.doe@example.com","label":"Personal","primary":true,"active":true}]

  - `content.emails.emailAddress` (string)
    Example: "john.doe@example.com"

  - `content.emails.label` (string)
    Example: "Personal"

  - `content.emails.primary` (boolean)
    Example: true

  - `content.emails.active` (boolean)
    Example: true

  - `content.phones` (array)
    Example: [{"number":"123-456-7890","label":"Work","type":"mobile","primary":true,"active":true}]

  - `content.phones.number` (string)
    Example: "123-456-7890"

  - `content.phones.type` (string)
    Enum: "mobile", "landline"

  - `content.customerType` (string)

  - `content.communicationPreference` (string)

  - `content.notes` (string)

  - `content.mainAddress` (object)
    Example: {"address":"123 Main St","city":"New York","state":"NY","zip":"10001","country":"USA"}

  - `content.mainAddress.address` (string)
    Example: "123 Main St"

  - `content.mainAddress.zip` (string)
    Example: "10001"

  - `content.mainAddress.city` (string)
    Example: "New York"

  - `content.mainAddress.state` (string)
    Example: "NY"

  - `content.mainAddress.country` (string)
    Example: "USA"

  - `content.secondaryAddress` (object)
    Example: {"address":"123 Main St","city":"New York","state":"NY","zip":"10001","country":"USA"}

  - `content.taxExempt` (boolean)

  - `content.tags` (array)
    Example: [{"name":"VIP","color":"FFFF00"}]

  - `content.tags.name` (string)
    Example: "VIP"

  - `content.tags.color` (string)
    Example: "FFFF00"

  - `content.chargeAccount` (boolean)

  - `content.preferredLocationID` (string)

  - `content.languagePreference` (string)

  - `content.okForMarketing` (boolean)

  - `content.createdDate` (string)

  - `content.updatedDate` (string)

  - `content.archivedDate` (string)