---
title: "Get customers"
method: GET
path: "/customers"
---

# Get customers

`GET /customers`

## Query parameters

- `limit` number
- `nextPage` string
- `useCrm` boolean
- `syncData` boolean
- `type` string
- `usePhone` boolean

## Response `200`

Fetched

- object
  - `count` number
  - `nextPage` string
  - `items` Customer[]
    - `customerId` string — The unique identifier of the customer
    - `orgId` string — Organization ID the customer belongs to
    - `userId` string — User ID associated with the customer
    - `advisorId` string — Advisor ID associated with the customer
    - `accountId` string — Salesforce account ID associated with the customer
    - `psuIdType` string — Type of PSU ID
    - `numberOfConnections` number — Number of connections associated with the customer
    - `firstName` string — Customer's first name
    - `lastName` string — Customer's last name
    - `nationalId` string — Customer's national ID
    - `nationalIdIssueDate` string, date — The date when the national ID was issued
    - `email` string — Customer's email address
    - `phoneNumber` string — Customer's phone number
    - `birthDate` string, date — Customer's birth date
    - `businessId` string — Business ID if the customer is a business
    - `businessCityName` string — City name of the business
    - `businessStreetName` string — Street name of the business
    - `businessStreetNumber` string — Street number of the business
    - `businessHouseNumber` string — House number of the business
    - `businessApartmentNumber` string — Apartment number of the business
    - `businessZipCode` string — Zip code of the business
    - `buisnessPostOfficeBox` string — Post office box of the business
    - `businessPhoneNumber` string — Business phone number
    - `businessName` string — Business name if the customer is a business
    - `businessType` string — Type of business
    - `businessEstablishedDate` string, date — The date when the business was established
    - `businessNumberOfOwners` number — Number of owners of the business
    - `businessNumberOfEmployees` number — Number of employees in the business
    - `businessIncomeFromLastFinancialStatement` number — Income from the last financial statement
    - `businessWebsiteUrl` string — URL of the business website
    - `activityArea` string — Area of business activity
    - `geoArea` string — Geographical area of the business
    - `customerReqFiles` RequiredFile[]
      - `fileName` string
      - `apiName` string
      - `label` object
        - `en` string
        - `he` string
      - `isRequired` boolean
    - `customerOtherFiles` RecordedFile[]
      - `url` string — URL to access the file from S3
      - `timestamp` number — Timestamp of the file
      - `fileName` string — Name of the file
      - `bucketPath` string — S3 bucket path where the file is stored
      - `bucketFileName` string — Name of the file in the S3 bucket
      - `processType` 'PCN' | '6111' | 'OSH' — Type of process the file is associated with
    - `hasFiles` boolean — Indicates if the customer has files
    - `hasReports` boolean — Indicates if the customer has reports
    - `hasOsh` boolean — Indicates if the customer has OSH
    - `hasEnrichedData` boolean — Indicates if the customer has enriched data
    - `hasConnections` boolean — Indicates if the customer has connections
    - `createdAt` string, date-time — The date when the customer was created

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `500` — Internal server error

---

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