---
title: "Get a customer"
method: GET
path: "/customers/{id}"
tags: ["Customers"]
---

# Get a customer

`GET /customers/{id}`

## Request

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

Retrieve a specific customer by its UUID.

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

- CustomerValue
  - `tenantId` string, uuid
  - `agencyId` string, uuid
  - `createdDate` string, date-time
  - `createdBy` string, uuid
  - `creatorName` string
  - `lastModifiedDate` string, date-time
  - `lastModifiedBy` string, uuid
  - `version` integer
  - `id` string, uuid
  - `duplicate` boolean
  - `statusId` string, uuid
  - `statusName` string
  - `statusActive` boolean
  - `sourceId` string, uuid
  - `sourceName` string
  - `customerClassId` string, uuid
  - `classId` string, uuid
  - `className` string
  - `managerId` string, uuid
  - `managers` string[]
  - `sensitive` boolean
  - `mailingStatus` 1 | 2 | 3 | 4: Mailing Status:<br/>1 - אושר דיוור<br/>2 - לא אושר דיוור<br/>3 - הוסר מדיוור<br/>4 - לא התבקש אישור
  - `mailingStatusDate` string, date-time
  - `idType` 1 | 2 | 3 | 4 | 5 | 6: Customer Identity Type:<br/>1 - ת.ז<br/>2 - דרכון<br/>3 - רישיון נהיגה<br/>4 - אחר<br/>5 - ח.פ<br/>6 - ח.צ
  - `idNumber` string
  - `idNumberLocked` boolean
  - `idCardIssueDate` string, date
  - `firstName` string
  - `shortName` string
  - `lastName` string
  - `fullName` string
  - `fullNameReverse` string
  - `maidenName` string
  - `engFirstName` string
  - `engLastName` string
  - `cellNumber` string
  - `cellNumberVerified` boolean
  - `cellNumberFormatted` string
  - `cellNumberUri` string
  - `cellNumberWhatsAppUri` string
  - `phoneNumber` string
  - `phoneNumberFormatted` string
  - `phoneNumberUri` string
  - `phoneNumberWhatsAppUri` string
  - `phoneNumber2` string
  - `phoneNumber2Formatted` string
  - `phoneNumber2Uri` string
  - `phoneNumber2WhatsAppUri` string
  - `phoneNumber3` string
  - `phoneNumber3Formatted` string
  - `phoneNumber3Uri` string
  - `phoneNumber3WhatsAppUri` string
  - `faxNumber` string
  - `faxNumberFormatted` string
  - `faxNumberUri` string
  - `email` string
  - `emailBounce` boolean
  - `emailComplaint` boolean
  - `otherEmail` string
  - `gender` 1 | 2 | 3: Gender:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה
  - `birthDate` string, date
  - `birthDay` integer
  - `birthMonth` integer
  - `birthYear` integer
  - `birthDateYearOnly` boolean
  - `age` string
  - `minor` boolean
  - `death` boolean
  - `deathDate` string, date
  - `street` string
  - `streetNumber` string
  - `apartmentNumber` string
  - `postalBox` integer
  - `city` string
  - `postalCode` integer
  - `country` string
  - `address` string
  - `maritalStatus` 1 | 2 | 3 | 4 | 5: Marital Status:<br/>1 - רווק/ה<br/>2 - נשוי/אה<br/>3 - גרוש/ה<br/>4 - אלמן/ה<br/>5 - ידוע/ה בציבור
  - `childrenCount` integer
  - `relatedCustomers` RelatedCustomerValue[]
    - `id` string, uuid
    - `customerId` string, uuid
    - `relatedCustomerId` string, uuid
    - `idType` 1 | 2 | 3 | 4 | 5 | 6: Customer Identity Type:<br/>1 - ת.ז<br/>2 - דרכון<br/>3 - רישיון נהיגה<br/>4 - אחר<br/>5 - ח.פ<br/>6 - ח.צ
    - `idNumber` string
    - `firstName` string
    - `lastName` string
    - `gender` 1 | 2 | 3: Gender:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה
    - `birthDate` string, date
    - `birthDateYearOnly` boolean
    - `death` boolean
    - `cellNumber` string
    - `email` string
    - `relationshipType` 'ילד' | 'בן_זוג' | 'הורה' | 'אח' | 'נכד' | 'סב' | 'גרוש' | 'אחר' | 'דוד' | 'אחיין'
    - `notes` string
  - `partnerId` string, uuid
  - `partnerName` string
  - `profession` string
  - `employmentStatus` 1 | 2 | 3 | 4 | 5 | 6 | 7: Employment Status:<br/>1 - שכיר/ה<br/>2 - עצמאי/ת<br/>3 - שכיר/ה ועצמאי/ת<br/>4 - שכיר/ה בעל/ת שליטה<br/>5 - לא מועסק/ת<br/>6 - שכיר/ה בעל/ת שליטה ועצמאי/ת<br/>7 - פנסיונר/ית
  - `employerId1` string, uuid
  - `employerName1` string
  - `employmentIncome1` integer
  - `employerId2` string, uuid
  - `employerName2` string
  - `employmentIncome2` integer
  - `employments` CustomerEmploymentValue[]
    - `id` string, uuid
    - `position` integer
    - `type` 1 | 2 | 3
    - `employerId` string, uuid
    - `employerName` string
    - `employerContactId` string, uuid
    - `occupation` string
    - `income` integer
    - `startDate` string, date
    - `endDate` string, date
    - `notes` string
    - `createdDate` string, date-time
    - `createdBy` string, uuid
  - `lastEmployment` CustomerEmploymentValue
    - `id` string, uuid
    - `position` integer
    - `type` 1 | 2 | 3
    - `employerId` string, uuid
    - `employerName` string
    - `employerContactId` string, uuid
    - `occupation` string
    - `income` integer
    - `startDate` string, date
    - `endDate` string, date
    - `notes` string
    - `createdDate` string, date-time
    - `createdBy` string, uuid
  - `usCitizen` boolean
  - `foreignTaxResidency` boolean
  - `engAddress` string
  - `taxResidencies` TaxResidency[]
    - `country` string
    - `taxIdNumber` string
  - `kupatHolim` 1 | 2 | 3 | 4 | 5: Kupat Holim:<br/>1 - כללית<br/>2 - מכבי<br/>3 - מאוחדת<br/>4 - לאומית<br/>5 - צה"לית
  - `kupatHolimComplementary` 10 | 11 | 20 | 21 | 22 | 30 | 31 | 40 | 41: Kupat Holim Complementary:<br/>10 - כללית מושלם זהב<br/>11 - כללית פלטינום<br/>20 - מכבי שלי<br/>21 - מכבי כסף<br/>22 - מכבי זהב<br/>30 - מאוחדת עדיף<br/>31 - מאוחדת שיא<br/>40 - לאומית כסף<br/>41 - לאומית זהב
  - `height` integer
  - `weight` integer
  - `smoker` boolean
  - `cigarettesCountPerDay` integer
  - `drugs` string
  - `surgeries` string
  - `hospitalizations` string
  - `backgroundDiseases` string
  - `bankAccountType` string
  - `bankCode` integer
  - `bankBranchCode` integer
  - `bankAccountNumber` string
  - `swiftnessProxyInviteDate` string, date
  - `swiftnessProxySignDate` string, date
  - `swiftnessProxyExpiryDate` string, date
  - `swiftnessProxyExpired` boolean
  - `lastE9100DataDate` string, date
  - `outdatedE9100Data` boolean
  - `swiftnessData` boolean
  - `hbProxyInviteDate` string, date
  - `hbProxySignDate` string, date
  - `hbProxyExpiryDate` string, date
  - `hbProxyExpired` boolean
  - `hbDataDate` string, date
  - `policiesProxyInviteDate` string, date
  - `policiesProxySignDate` string, date
  - `policiesProxyExpiryDate` string, date
  - `policiesProxyExpired` boolean
  - `lastSwiftnessProductiaMonth` string
  - `lastPratProductiaMonth` string
  - `lastProductiaMonth` string
  - `notes` string
  - `notesUpdatedBy` string, uuid
  - `notesUpdatedAt` string, date-time
  - `notesAlert` boolean
  - `customFields` SmartDialogFieldValue[]
    - `fieldId` string, uuid
    - `type` integer
    - `value` object
  - `reportEnabled` boolean
  - `reportPeriod` 'חד_פעמי' | 'חודשי' | 'רבעוני' | 'חצי_שנתי' | 'שנתי'
  - `reportFormat` 'ממשק_אינטרנטי' | 'PDF'
  - `reportByEmail` boolean
  - `reportByCellNumber` boolean
  - `reportIncludesInvestmentProducts` boolean
  - `reportIncludesInsuranceProducts` boolean
  - `reportDetailType` 1 | 2 | 3
  - `reportFamily` boolean
  - `reportFamilyDate` string, date-time
  - `reportFamilyExpiryDate` string, date-time
  - `reportFamilyExpired` boolean
  - `lastSentConsultingReportId` string, uuid
  - `lastSentConsultingReportTimestamp` string, date-time
  - `lastSentProductiaReportId` string, uuid
  - `lastSentProductiaReportTimestamp` string, date-time
  - `lastProductiaReportAccessDate` string, date-time
  - `lastActivityDate` string, date-time
  - `lastActivityBy` string, uuid
  - `lastMeetingDate` string, date
  - `monthlyRevenue` number
  - `appMailAddress` string
  - `tromStats` TromStats
    - `validityMonth` string
    - `calculatedAt` string, date-time
    - `tzvira` number
    - `tzviraHon` number
    - `tzviraKitzba` number
    - `tzviraPitsuim` number
    - `tzviraPensia` number
    - `tzviraPensiaVatika` number
    - `tzviraMenaalim` number
    - `tzviraHishtalmut` number
    - `tzviraGemelLeashkaa` number
    - `tzviraGemel` number
    - `tzviraGemel190` number
    - `tzviraHisahonFinansi` number
    - `tzviraAlternativiim` number
    - `tzviraNihulTikim` number
    - `tzviraNezila` number
    - `hafkadot` number
    - `hafkadotHishtalmut` number
    - `hafkadotGemelLeashkaa` number
    - `dmeiNihulHazuim` number
    - `revahimMithilatShana` number
    - `avgNetReturnPercentStartYear` number
    - `kitzbaHazuyaKolelHafkadot` number
    - `kitzbaHazuyaLeloHafkadot` number
    - `kayamHalvaot` boolean
    - `kayamIkulimShiabudim` boolean
    - `premia` number
    - `kayamHaim` boolean
    - `premiaHaim` number
    - `kayamHaimMashkanta` boolean
    - `premiaHaimMashkanta` number
    - `kayamBriut` boolean
    - `premiaBriut` number
    - `kayamMahalotKashot` boolean
    - `premiaMahalotKashot` number
    - `kayamTeunotIshiot` boolean
    - `premiaTeunotIshiot` number
    - `kayamSiudi` boolean
    - `premiaSiudi` number
    - `kayamSiudiKupah` boolean
    - `kayamAka` boolean
    - `kayamNehutMiteuna` boolean
    - `kitzbaNehut` number
    - `kitzbaLealman` number
    - `kitzbaLeyetom` number
    - `kisuiHadPaamiSheerim` number
  - `productiaStats` ProductiaStats
    - `statsValidityMonth` string
    - `statsDate` string, date-time
    - `statsTzvira` number
    - `statsTzviraHon` number
    - `statsTzviraKitzba` number
    - `statsTzviraPitsuim` number
    - `statsTzviraPensia` number
    - `statsTzviraPensiaVatika` number
    - `statsTzviraMenaalim` number
    - `statsTzviraHishtalmut` number
    - `statsTzviraGemelLeashkaa` number
    - `statsTzviraGemel` number
    - `statsTzviraGemel190` number
    - `statsTzviraHisahonFinansi` number
    - `statsTzviraAlternativiim` number
    - `statsTzviraNihulTikim` number
    - `statsTzviraNezila` number
    - `statsHafkadot` number
    - `statsHafkadotHishtalmut` number
    - `statsHafkadotGemelLeashkaa` number
    - `statsDmeiNihulHazuim` number
    - `statsRevahimMithilatShana` number
    - `statsAvgNetReturnPercentStartYear` number
    - `statsKitzbaHazuyaKolelHafkadot` number
    - `statsKitzbaHazuyaLeloHafkadot` number
    - `statsKayamHalvaot` boolean
    - `statsKayamIkulimShiabudim` boolean
    - `statsPremia` number
    - `statsKayamHaim` boolean
    - `statsPremiaHaim` number
    - `statsKayamHaimMashkanta` boolean
    - `statsPremiaHaimMashkanta` number
    - `statsKayamBriut` boolean
    - `statsPremiaBriut` number
    - `statsKayamMahalotKashot` boolean
    - `statsPremiaMahalotKashot` number
    - `statsKayamTeunotIshiot` boolean
    - `statsPremiaTeunotIshiot` number
    - `statsKayamSiudi` boolean
    - `statsPremiaSiudi` number
    - `statsKayamSiudiKupah` boolean
    - `statsKayamAka` boolean
    - `statsKayamNehutMiteuna` boolean
    - `statsKitzbaNehut` number
    - `statsKitzbaLealman` number
    - `statsKitzbaLeyetom` number
    - `statsKisuiHadPaamiSheerim` number
  - `customerServiceEnabled` boolean
  - `customerServiceRecurrence` 1 | 2 | 3 | 4
  - `customerServiceSms` boolean
  - `customerServiceEmail` boolean
  - `tags` string[]
  - `surenseOneActive` 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)