Skip to main content

Get list of public businesses without populating related data

GET /api/v1/businesses/basic/public

Description

Retrieve a list of public business entities without populating related data.

URL:

  • Raw URL: /api/v1/businesses/basic/public

  • Host:

  • Path: /api/v1/businesses/basic/public

Query Parameters:

  • fieldNames: - Allowed fields separated by a comma: name, location, address, photo, businessHandle, wallet, user, phone, category, active, acceptingOrder, isDistributor

  • businessDateRange: - Date range for businesses, e.g., "2020-11-12,2022-11-15"

  • businessAddress: - Filter by business address

  • businessByKycStatus: APPROVE - Filter by KYC status

  • businessByWalletAccount: - Filter by wallet account

  • businessByLocations: - Location filter (e.g., longitude,latitude or -40.943,29.2933)

  • businessBySources: - Comma-separated list of sources (e.g., SHOP,TRACE,AGENCY,AGENT,DEAL,OWN,PLATFORM)

  • businessByTypes: - Comma-separated list of business types (e.g., SUPPLIER,MERCHANT,AGENCY_BANKING,SABI_AGENT,SABI_OWN)

  • businessByUserIds: - Filter by user IDs

  • businessByTenantIds: - Filter by tenant IDs

  • businessByIds: - Filter by business IDs

  • businessSearch: - Search keyword

  • businessByIsDistributor: 1 - Filter by distributor status

  • businessByAcceptingOrder: 1 - Filter by accepting order status

  • businessByActive: 1 - Filter by active status

  • order: DESC - Sorting order

  • limit: - Maximum number of results to return

Response:

  • Status: OK (200)

This documentation provides information on how to use the "Businesses Controller find All Without Populate" endpoint to retrieve a list of public business entities without populating related data based on various parameters.

/api/v1/businesses/basic/public?fieldNames=<string>&businessDateRange=<string>&businessAddress=<string>&businessByKycStatus=APPROVE&businessByWalletAccount=<string>&businessByLocations=<string>&businessBySources=<string>&businessByTypes=<string>&businessByUserIds=<string>&businessByTenantIds=<string>&businessByIds=<string>&businessSearch=<string>&businessByIsDistributor=1&businessByAcceptingOrder=1&businessByActive=1&order=DESC&limit=<string>

Query Params

Paramvalue
fieldNamesstring
businessDateRangestring
businessAddressstring
businessByKycStatusAPPROVE
businessByWalletAccountstring
businessByLocationsstring
businessBySourcesstring
businessByTypesstring
businessByUserIdsstring
businessByTenantIdsstring
businessByIdsstring
businessSearchstring
businessByIsDistributor1
businessByAcceptingOrder1
businessByActive1
orderDESC
limitstring

Response: 200

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /api/v1/businesses/basic/public \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!