---
title: "searchAcceptorKala"
method: GET
path: "/api/public/acceptors/search-with-kala"
tags: ["acceptor-public-resource"]
---

# searchAcceptorKala

`GET /api/public/acceptors/search-with-kala`

## Request

- Base URL: `https://api.ayriaclub.ir`
- URL: `https://api.ayriaclub.ir/api/public/acceptors/search-with-kala`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ayriaclub/apis/ayria-api/docs/api/public/acceptors/search-with-kala/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `acceptorName.contains` string
- `acceptorName.doesNotContain` string
- `acceptorName.equals` string
- `acceptorName.in` string[]
- `acceptorName.notEquals` string
- `acceptorName.notIn` string[]
- `acceptorName.specified` boolean
- `acceptorNameEn.contains` string
- `acceptorNameEn.doesNotContain` string
- `acceptorNameEn.equals` string
- `acceptorNameEn.in` string[]
- `acceptorNameEn.notEquals` string
- `acceptorNameEn.notIn` string[]
- `acceptorNameEn.specified` boolean
- `accountNumber.contains` string
- `accountNumber.doesNotContain` string
- `accountNumber.equals` string
- `accountNumber.in` string[]
- `accountNumber.notEquals` string
- `accountNumber.notIn` string[]
- `accountNumber.specified` boolean
- `address.contains` string
- `address.doesNotContain` string
- `address.equals` string
- `address.in` string[]
- `address.notEquals` string
- `address.notIn` string[]
- `address.specified` boolean
- `bank.contains` string
- `bank.doesNotContain` string
- `bank.equals` string
- `bank.in` string[]
- `bank.notEquals` string
- `bank.notIn` string[]
- `bank.specified` boolean
- `birthCertDigit.contains` string
- `birthCertDigit.doesNotContain` string
- `birthCertDigit.equals` string
- `birthCertDigit.in` string[]
- `birthCertDigit.notEquals` string
- `birthCertDigit.notIn` string[]
- `birthCertDigit.specified` boolean
- `birthCertLetter.contains` string
- `birthCertLetter.doesNotContain` string
- `birthCertLetter.equals` string
- `birthCertLetter.in` string[]
- `birthCertLetter.notEquals` string
- `birthCertLetter.notIn` string[]
- `birthCertLetter.specified` boolean
- `birthCertNumber.contains` string
- `birthCertNumber.doesNotContain` string
- `birthCertNumber.equals` string
- `birthCertNumber.in` string[]
- `birthCertNumber.notEquals` string
- `birthCertNumber.notIn` string[]
- `birthCertNumber.specified` boolean
- `birthCertSeriesNumber.contains` string
- `birthCertSeriesNumber.doesNotContain` string
- `birthCertSeriesNumber.equals` string
- `birthCertSeriesNumber.in` string[]
- `birthCertSeriesNumber.notEquals` string
- `birthCertSeriesNumber.notIn` string[]
- `birthCertSeriesNumber.specified` boolean
- `branch.contains` string
- `branch.doesNotContain` string
- `branch.equals` string
- `branch.in` string[]
- `branch.notEquals` string
- `branch.notIn` string[]
- `branch.specified` boolean
- `category.contains` string
- `category.doesNotContain` string
- `category.equals` string
- `category.in` string[]
- `category.notEquals` string
- `category.notIn` string[]
- `category.specified` boolean
- `city.contains` string
- `city.doesNotContain` string
- `city.equals` string
- `city.in` string[]
- `city.notEquals` string
- `city.notIn` string[]
- `city.specified` boolean
- `clubCode.equals` integer
- `clubCode.greaterThan` integer
- `clubCode.greaterThanOrEqual` integer
- `clubCode.in` integer[]
- `clubCode.lessThan` integer
- `clubCode.lessThanOrEqual` integer
- `clubCode.notEquals` integer
- `clubCode.notIn` integer[]
- `clubCode.specified` boolean
- `code.contains` string
- `code.doesNotContain` string
- `code.equals` string
- `code.in` string[]
- `code.notEquals` string
- `code.notIn` string[]
- `code.specified` boolean
- `createdDate.equals` string, date-time
- `createdDate.greaterThan` string, date-time
- `createdDate.greaterThanOrEqual` string, date-time
- `createdDate.in[0].epochSecond` integer
- `createdDate.in[0].nano` integer
- `createdDate.lessThan` string, date-time
- `createdDate.lessThanOrEqual` string, date-time
- `createdDate.notEquals` string, date-time
- `createdDate.notIn[0].epochSecond` integer
- `createdDate.notIn[0].nano` integer
- `createdDate.specified` boolean
- `dateOfBirth.contains` string
- `dateOfBirth.doesNotContain` string
- `dateOfBirth.equals` string
- `dateOfBirth.in` string[]
- `dateOfBirth.notEquals` string
- `dateOfBirth.notIn` string[]
- `dateOfBirth.specified` boolean
- `department.equals` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
- `department.in` string[]
- `department.notEquals` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
- `department.notIn` string[]
- `department.specified` boolean
- `description.contains` string
- `description.doesNotContain` string
- `description.equals` string
- `description.in` string[]
- `description.notEquals` string
- `description.notIn` string[]
- `description.specified` boolean
- `deviceConnType.equals` 'POS' | 'PORTABLE_POS' | 'QRCODE'
- `deviceConnType.in` string[]
- `deviceConnType.notEquals` 'POS' | 'PORTABLE_POS' | 'QRCODE'
- `deviceConnType.notIn` string[]
- `deviceConnType.specified` boolean
- `discountPercentage.equals` number, double
- `discountPercentage.greaterThan` number, double
- `discountPercentage.greaterThanOrEqual` number, double
- `discountPercentage.in` number[]
- `discountPercentage.lessThan` number, double
- `discountPercentage.lessThanOrEqual` number, double
- `discountPercentage.notEquals` number, double
- `discountPercentage.notIn` number[]
- `discountPercentage.specified` boolean
- `documentsId.equals` integer
- `documentsId.greaterThan` integer
- `documentsId.greaterThanOrEqual` integer
- `documentsId.in` integer[]
- `documentsId.lessThan` integer
- `documentsId.lessThanOrEqual` integer
- `documentsId.notEquals` integer
- `documentsId.notIn` integer[]
- `documentsId.specified` boolean
- `familyName.contains` string
- `familyName.doesNotContain` string
- `familyName.equals` string
- `familyName.in` string[]
- `familyName.notEquals` string
- `familyName.notIn` string[]
- `familyName.specified` boolean
- `familyNameEn.contains` string
- `familyNameEn.doesNotContain` string
- `familyNameEn.equals` string
- `familyNameEn.in` string[]
- `familyNameEn.notEquals` string
- `familyNameEn.notIn` string[]
- `familyNameEn.specified` boolean
- `fatherName.contains` string
- `fatherName.doesNotContain` string
- `fatherName.equals` string
- `fatherName.in` string[]
- `fatherName.notEquals` string
- `fatherName.notIn` string[]
- `fatherName.specified` boolean
- `fromDate.equals` string, date
- `fromDate.greaterThan` string, date
- `fromDate.greaterThanOrEqual` string, date
- `fromDate.in[0].chronology.calendarType` string
- `fromDate.in[0].chronology.id` string
- `fromDate.in[0].dayOfMonth` integer
- `fromDate.in[0].dayOfWeek` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
- `fromDate.in[0].dayOfYear` integer
- `fromDate.in[0].era` 'BCE' | 'CE'
- `fromDate.in[0].leapYear` boolean
- `fromDate.in[0].month` 'JANUARY' | 'FEBRUARY' | 'MARCH' | 'APRIL' | 'MAY' | 'JUNE' | 'JULY' | 'AUGUST' | 'SEPTEMBER' | 'OCTOBER' | 'NOVEMBER' | 'DECEMBER'
- `fromDate.in[0].monthValue` integer
- `fromDate.in[0].year` integer
- `fromDate.lessThan` string, date
- `fromDate.lessThanOrEqual` string, date
- `fromDate.notEquals` string, date
- `fromDate.notIn[0].chronology.calendarType` string
- `fromDate.notIn[0].chronology.id` string
- `fromDate.notIn[0].dayOfMonth` integer
- `fromDate.notIn[0].dayOfWeek` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
- `fromDate.notIn[0].dayOfYear` integer
- `fromDate.notIn[0].era` 'BCE' | 'CE'
- `fromDate.notIn[0].leapYear` boolean
- `fromDate.notIn[0].month` 'JANUARY' | 'FEBRUARY' | 'MARCH' | 'APRIL' | 'MAY' | 'JUNE' | 'JULY' | 'AUGUST' | 'SEPTEMBER' | 'OCTOBER' | 'NOVEMBER' | 'DECEMBER'
- `fromDate.notIn[0].monthValue` integer
- `fromDate.notIn[0].year` integer
- `fromDate.specified` boolean
- `gender.equals` 'MALE' | 'FEMALE'
- `gender.in` string[]
- `gender.notEquals` 'MALE' | 'FEMALE'
- `gender.notIn` string[]
- `gender.specified` boolean
- `givenName.contains` string
- `givenName.doesNotContain` string
- `givenName.equals` string
- `givenName.in` string[]
- `givenName.notEquals` string
- `givenName.notIn` string[]
- `givenName.specified` boolean
- `givenNameEn.contains` string
- `givenNameEn.doesNotContain` string
- `givenNameEn.equals` string
- `givenNameEn.in` string[]
- `givenNameEn.notEquals` string
- `givenNameEn.notIn` string[]
- `givenNameEn.specified` boolean
- `id.equals` integer
- `id.greaterThan` integer
- `id.greaterThanOrEqual` integer
- `id.in` integer[]
- `id.lessThan` integer
- `id.lessThanOrEqual` integer
- `id.notEquals` integer
- `id.notIn` integer[]
- `id.specified` boolean
- `kargozarId.equals` integer
- `kargozarId.greaterThan` integer
- `kargozarId.greaterThanOrEqual` integer
- `kargozarId.in` integer[]
- `kargozarId.lessThan` integer
- `kargozarId.lessThanOrEqual` integer
- `kargozarId.notEquals` integer
- `kargozarId.notIn` integer[]
- `kargozarId.specified` boolean
- `makePublic.equals` boolean
- `makePublic.in` boolean[]
- `makePublic.notEquals` boolean
- `makePublic.notIn` boolean[]
- `makePublic.specified` boolean
- `mobile.contains` string
- `mobile.doesNotContain` string
- `mobile.equals` string
- `mobile.in` string[]
- `mobile.notEquals` string
- `mobile.notIn` string[]
- `mobile.specified` boolean
- `nationalIdNumber.contains` string
- `nationalIdNumber.doesNotContain` string
- `nationalIdNumber.equals` string
- `nationalIdNumber.in` string[]
- `nationalIdNumber.notEquals` string
- `nationalIdNumber.notIn` string[]
- `nationalIdNumber.specified` boolean
- `nationality.equals` 'IRANIAN' | 'FOREIGNER'
- `nationality.in` string[]
- `nationality.notEquals` 'IRANIAN' | 'FOREIGNER'
- `nationality.notIn` string[]
- `nationality.specified` boolean
- `ostanId.equals` integer
- `ostanId.greaterThan` integer
- `ostanId.greaterThanOrEqual` integer
- `ostanId.in` integer[]
- `ostanId.lessThan` integer
- `ostanId.lessThanOrEqual` integer
- `ostanId.notEquals` integer
- `ostanId.notIn` integer[]
- `ostanId.specified` boolean
- `page` integer
- `phone.contains` string
- `phone.doesNotContain` string
- `phone.equals` string
- `phone.in` string[]
- `phone.notEquals` string
- `phone.notIn` string[]
- `phone.specified` boolean
- `platformDiscountPercentage.equals` number, double
- `platformDiscountPercentage.greaterThan` number, double
- `platformDiscountPercentage.greaterThanOrEqual` number, double
- `platformDiscountPercentage.in` number[]
- `platformDiscountPercentage.lessThan` number, double
- `platformDiscountPercentage.lessThanOrEqual` number, double
- `platformDiscountPercentage.notEquals` number, double
- `platformDiscountPercentage.notIn` number[]
- `platformDiscountPercentage.specified` boolean
- `postcode.contains` string
- `postcode.doesNotContain` string
- `postcode.equals` string
- `postcode.in` string[]
- `postcode.notEquals` string
- `postcode.notIn` string[]
- `postcode.specified` boolean
- `rank.equals` integer
- `rank.greaterThan` integer
- `rank.greaterThanOrEqual` integer
- `rank.in` integer[]
- `rank.lessThan` integer
- `rank.lessThanOrEqual` integer
- `rank.notEquals` integer
- `rank.notIn` integer[]
- `rank.specified` boolean
- `rate.equals` integer
- `rate.greaterThan` integer
- `rate.greaterThanOrEqual` integer
- `rate.in` integer[]
- `rate.lessThan` integer
- `rate.lessThanOrEqual` integer
- `rate.notEquals` integer
- `rate.notIn` integer[]
- `rate.specified` boolean
- `registrarId.equals` integer
- `registrarId.greaterThan` integer
- `registrarId.greaterThanOrEqual` integer
- `registrarId.in` integer[]
- `registrarId.lessThan` integer
- `registrarId.lessThanOrEqual` integer
- `registrarId.notEquals` integer
- `registrarId.notIn` integer[]
- `registrarId.specified` boolean
- `shebaCode.contains` string
- `shebaCode.doesNotContain` string
- `shebaCode.equals` string
- `shebaCode.in` string[]
- `shebaCode.notEquals` string
- `shebaCode.notIn` string[]
- `shebaCode.specified` boolean
- `shippingAddressId` integer
- `shippingAddressLatLng` string
- `shortDescription.contains` string
- `shortDescription.doesNotContain` string
- `shortDescription.equals` string
- `shortDescription.in` string[]
- `shortDescription.notEquals` string
- `shortDescription.notIn` string[]
- `shortDescription.specified` boolean
- `size` integer
- `sort` string[]
- `state.contains` string
- `state.doesNotContain` string
- `state.equals` string
- `state.in` string[]
- `state.notEquals` string
- `state.notIn` string[]
- `state.specified` boolean
- `status.equals` 'REQUESTED' | 'CONFIRMED' | 'DOCUMENT_INCOMPLETE' | 'DOCUMENT_CONFIRMED' | 'DOCUMENT_SENT' | 'NEEDTOREVIEW' | 'COMPLETE_PROFILE' | 'ACTIVE' | 'INACTIVE' | 'SYSTEM' | 'EXPIRED' | 'NOTRANSACTION' | 'CLOSED' | 'ORGANIZATIONAL' | 'BUILDING'
- `status.in` string[]
- `status.notEquals` 'REQUESTED' | 'CONFIRMED' | 'DOCUMENT_INCOMPLETE' | 'DOCUMENT_CONFIRMED' | 'DOCUMENT_SENT' | 'NEEDTOREVIEW' | 'COMPLETE_PROFILE' | 'ACTIVE' | 'INACTIVE' | 'SYSTEM' | 'EXPIRED' | 'NOTRANSACTION' | 'CLOSED' | 'ORGANIZATIONAL' | 'BUILDING'
- `status.notIn` string[]
- `status.specified` boolean
- `toDate.equals` string, date
- `toDate.greaterThan` string, date
- `toDate.greaterThanOrEqual` string, date
- `toDate.in[0].chronology.calendarType` string
- `toDate.in[0].chronology.id` string
- `toDate.in[0].dayOfMonth` integer
- `toDate.in[0].dayOfWeek` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
- `toDate.in[0].dayOfYear` integer
- `toDate.in[0].era` 'BCE' | 'CE'
- `toDate.in[0].leapYear` boolean
- `toDate.in[0].month` 'JANUARY' | 'FEBRUARY' | 'MARCH' | 'APRIL' | 'MAY' | 'JUNE' | 'JULY' | 'AUGUST' | 'SEPTEMBER' | 'OCTOBER' | 'NOVEMBER' | 'DECEMBER'
- `toDate.in[0].monthValue` integer
- `toDate.in[0].year` integer
- `toDate.lessThan` string, date
- `toDate.lessThanOrEqual` string, date
- `toDate.notEquals` string, date
- `toDate.notIn[0].chronology.calendarType` string
- `toDate.notIn[0].chronology.id` string
- `toDate.notIn[0].dayOfMonth` integer
- `toDate.notIn[0].dayOfWeek` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
- `toDate.notIn[0].dayOfYear` integer
- `toDate.notIn[0].era` 'BCE' | 'CE'
- `toDate.notIn[0].leapYear` boolean
- `toDate.notIn[0].month` 'JANUARY' | 'FEBRUARY' | 'MARCH' | 'APRIL' | 'MAY' | 'JUNE' | 'JULY' | 'AUGUST' | 'SEPTEMBER' | 'OCTOBER' | 'NOVEMBER' | 'DECEMBER'
- `toDate.notIn[0].monthValue` integer
- `toDate.notIn[0].year` integer
- `toDate.specified` boolean

## Response `200`

OK

- AcceptorKalaSearchDTO
  - `acceptors` PageOfAcceptorSummaryDTO
    - `content` AcceptorSummaryDTO[]
      - `acceptorName` string
      - `acceptorNameEn` string
      - `address` string
      - `banner` string
      - `bannerDesktop` string
      - `branch` string
      - `category` string
      - `city` string
      - `code` string
      - `contacts` AcceptorContactDTO[]
        - `contactType` 'TELEGRAM' | 'INSTAGRAM' | 'FACEBOOK' | 'LINKEDIN' | 'TWITTER' | 'WHATSAPP' | 'EMAIL' | 'ADDRESS' | 'COORDINATES' | 'TELEPHONE' | 'MOBILE' | 'WEBSITE'
        - `value` string
      - `coordinates` string
      - `delivery` boolean
      - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
      - `description` string
      - `discountPercentage` number, double
      - `distanceTo` number, double
      - `documents` DocumentSummaryDTO[]
        - `contentContentType` string
        - `description` string
        - `documentIdentifier` string
        - `documentType` 'LOGO' | 'MENU' | 'PHOTO' | 'PHOTO_BUILDING' | 'DOCUMENT' | 'BANNER' | 'BANNER_LANDING' | 'BANNER_LANDING_DESKTOP' | 'ID_NATIONAL_CODE' | 'ID_IDENTITY_NUMBER' | 'ID_BUSINESS_LICENSE' | 'ID_SHEBA_CONFIRMATION' | 'ID_POSTAL_CODE' | 'ID_APG_CONTRACT' | 'ID_POS_CONTRACT' | 'ID_ACCEPTOR_CONFIRMATION' | 'ID_OTHERS', required
        - `id` integer
        - `publicUrl` string
        - `uploadedOn` string, date-time, required
      - `facilities` AcceptorFacilityDTO[]
        - `acceptorId` integer
        - `facilityCode` string
        - `facilityId` integer
        - `facilityName` string
        - `id` integer
      - `id` integer
      - `latitude` number, double
      - `logo` string
      - `longitude` number, double
      - `open` boolean
      - `pickup` boolean
      - `platformDiscountPercentage` number, double
      - `postcode` string
      - `rateStats` RateStats
        - `dislikesPercentage` number
        - `indifferencePercentage` number
        - `likesPercentage` number
        - `rate` number
        - `total` integer
        - `totalDislikes` integer
        - `totalIndifference` integer
        - `totalLikes` integer
      - `referralCode` integer
      - `shortDescription` string
      - `state` string
      - `storeType` 'VIRTUAL' | 'PHYSICAL'
      - `tables` boolean
      - `tradingHours` TradingHoursDTO
        - `fri` string
        - `id` integer
        - `mon` string
        - `name` string
        - `publicHolidays` string
        - `sat` string
        - `sun` string
        - `thu` string
        - `tue` string
        - `wed` string
    - `empty` boolean
    - `first` boolean
    - `last` boolean
    - `number` integer
    - `numberOfElements` integer
    - `size` integer
    - `sort` Sort
      - `empty` boolean
      - `sorted` boolean
      - `unsorted` boolean
    - `totalElements` integer
    - `totalPages` integer
  - `kalas` PageOfKalaPublicDTO
    - `content` KalaPublicDTO[]
      - `acceptor` AcceptorPublicDTO
        - `acceptorName` string
        - `acceptorNameEn` string
        - `anonymousPay` boolean
        - `apgSecond` boolean
        - `code` string
        - `delivery` boolean
        - `department` 'SPORT' | 'CLOTHING' | 'CONSULTING' | 'DIGITAL' | 'RESTAURANT' | 'HEALTH' | 'SCIENCE' | 'STORE' | 'TRAVEL' | 'HOME_APPLIANCE' | 'BEAUTY' | 'JEWELLERY' | 'CULTURE' | 'FORMALITY' | 'ART' | 'CAR' | 'BUILDING'
        - `onlineSell` boolean
        - `onlineShop` boolean
        - `pickup` boolean
        - `pickupGap` integer
        - `referralCode` integer
        - `shortDescription` string
        - `tables` boolean
        - `targetGroup` 'MALE' | 'FEMALE' | 'UNISEX'
        - `tax` boolean
        - `taxDivider` number, double
      - `acceptorCode` integer
      - `acceptorName` string
      - `baseImageUrl` string
      - `brand` BrandPublicDTO
        - `name` string
      - `description` string
      - `id` integer
      - `images` string[]
      - `inventoryCount` integer
      - `name` string
      - `nameEn` string
      - `outOfStock` boolean
      - `price` number
      - `prices` KalaPriceDTO[]
        - `deleted` boolean
        - `id` integer
        - `kalaId` integer
        - `kalaName` string
        - `name` string
        - `order` integer
        - `price` number, required
        - `selected` boolean
        - `type` 'COLOR' | 'SIZE', required
      - `service` boolean
    - `empty` boolean
    - `first` boolean
    - `last` boolean
    - `number` integer
    - `numberOfElements` integer
    - `size` integer
    - `sort` Sort
      - `empty` boolean
      - `sorted` boolean
      - `unsorted` boolean
    - `totalElements` integer
    - `totalPages` integer

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/ayriaclub/apis/ayria-api.md) - [All operations](https://skmtc.dev/ayriaclub/apis/ayria-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ayriaclub/apis/ayria-api/revisions/422df181c1dd?raw)