---
title: "Get brief customers"
method: POST
path: "/customers/brief"
tags: ["Customers"]
---

# Get brief customers

`POST /customers/brief`

## Request

- Base URL: `https://api.surense.com/api/v1`
- URL: `https://api.surense.com/api/v1/customers/brief`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.surense.com/oauth/token` scopes: `customers:read`

Retrieve brief details for a list of customer UUIDs.

## Request body

- CustomerBriefRequest
  - `customerIds` string[], required

## Response `200`

OK

- CustomerBriefValue[]
  - `id` string, uuid
  - `firstName` string
  - `lastName` string
  - `fullName` string
  - `gender` 1 | 2 | 3: Gender:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה
  - `statusActive` boolean
  - `statusId` string, uuid
  - `classId` string, uuid
  - `sourceId` string, uuid
  - `isFound` boolean
  - `isAccessible` boolean
  - `accessible` boolean
  - `found` boolean

---

[API](https://skmtc.dev/surense/apis/customer-service.md) - [All operations](https://skmtc.dev/surense/apis/customer-service/llms.txt) - [OpenAPI document](https://skmtc.dev/surense/apis/customer-service/revisions/f794569f5ccb?raw)
