---
title: "Get customers by Customer Ids (getCustomersByIds)"
method: GET
path: "/api/customers"
tags: ["customer-controller"]
---

# Get customers by Customer Ids (getCustomersByIds)

`GET /api/customers`

Returns a list of Customer objects based on the provided ids.

Available for users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority.

## Query parameters

- `pageSize` integer, required
- `page` integer, required
- `textSearch` string
- `sortProperty` 'createdTime' | 'title' | 'email' | 'country' | 'city'
- `sortOrder` 'ASC' | 'DESC'
- `customerIds` string[], required

## Response `200`

OK

- union
  - Customer[]
    - `id` CustomerId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'CUSTOMER', required — string
    - `createdTime` integer — Timestamp of the customer creation, in milliseconds
    - `country` string — Country
    - `state` string — State
    - `city` string — City
    - `address` string — Address Line 1
    - `address2` string — Address Line 2
    - `zip` string — Zip code
    - `phone` string — Phone number
    - `email` string, required — Email
    - `title` string, required — Title of the customer
    - `tenantId` TenantId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'TENANT', required — string
    - `version` integer
    - `name` string — Name of the customer. Read-only, duplicated from title for backward compatibility
    - `additionalInfo` unknown
  - PageDataCustomer
    - `data` Customer[] — Array of the entities
      - `id` CustomerId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'CUSTOMER', required — string
      - `createdTime` integer — Timestamp of the customer creation, in milliseconds
      - `country` string — Country
      - `state` string — State
      - `city` string — City
      - `address` string — Address Line 1
      - `address2` string — Address Line 2
      - `zip` string — Zip code
      - `phone` string — Phone number
      - `email` string, required — Email
      - `title` string, required — Title of the customer
      - `tenantId` TenantId
        - `id` string, uuid, required — ID of the entity, time-based UUID v1
        - `entityType` 'TENANT', required — string
      - `version` integer
      - `name` string — Name of the customer. Read-only, duplicated from title for backward compatibility
      - `additionalInfo` unknown
    - `totalPages` integer — Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria
    - `totalElements` integer — Total number of elements in all available pages
    - `hasNext` boolean — 'false' value indicates the end of the result set

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)