Get all businesses

Request

Get all businesses. Use pagination parameters (page & limit) for optimal performance. Legacy support: returns array without params (deprecated - will be removed in future). Project API key users get active businesses only. Admin users (with valid JWT) get full access with query parameters.

Security

authJWT or projectKey

Query

activestring

Filter by active status (admin only for inactive)

searchstring

Free text search across business name and legal name (case-insensitive)

sanitizestring

Sanitize user models: soft checks for current wallet address, hard overwrites wallet in case of update (use with caution, admin only)

pagenumber

Page number (1-based)

limitnumber

Items per page

sortBystring

Sort field

Enum:"name""createdAt""businessLegalName"

sortOrderstring

Sort direction

Enum:"ASC""DESC"

businessTypeIdnumber

Filter by business type ID

citystring

Filter by city (case-insensitive)

countryCodestring

Filter by country code (ISO 3166-1 alpha-2, e.g., QA, US)

countrystring

Filter by country name (case-insensitive)

neighborhoodstring

Filter by neighborhood (case-insensitive)

districtstring

Filter by district (case-insensitive)

latitudenumber

Latitude for geographic radius search (must be used with longitude and radiusMeters)

Example:latitude=25.2854

longitudenumber

Longitude for geographic radius search (must be used with latitude and radiusMeters)

Example:longitude=51.531

radiusMetersnumber

Radius in meters for geographic search (must be used with latitude and longitude)

Example:radiusMeters=500

approvalStatusstring

Filter by approval status (admin only)

Enum:"pending_approval""approved""rejected"

canMintTokenstring

Filter by ERC20 delegated-mint capability

canChargeTokenstring

Filter by point-of-sale token-charge capability

canManageUsersstring

Filter by user-management capability

canReceiveDonationstring

Filter by donation-receiving capability

tagsArray of strings

Filter by tag(s). Comma-separated or multiple params for OR matching.

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/businesses?active=string&search=string&sanitize=string&page=0&limit=0&sortBy=name&sortOrder=ASC&businessTypeId=0&city=string&countryCode=string&country=string&neighborhood=string&district=string&latitude=25.2854&longitude=51.531&radiusMeters=500&approvalStatus=pending_approval&canMintToken=string&canChargeToken=string&canManageUsers=string&canReceiveDonation=string&tags=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Businesses found

Bodyapplication/json

Array [

idstringrequired

The id of the business, this is unique and will be used to identify the business.

emailstring or nullrequired

The email of the business, this is unique and will be used to identify the business.

currentSigningAccountIdstring or nullrequired

Current active signing account ID for external wallet operations

walletsArray of objects(PublicWalletDTO)required

Business-owned counterfactual smart contract wallets that can receive tokens

businessLegalNamestring or nullrequired

The legal name of the business, this is the name that will be used for legal purposes.

registrationNumberstring or nullrequired

The business registration number (e.g., company registration, VAT number, EIN)

displayNamestring or nullrequired

The display name of the business, this is the name that will be shown to the public.

descriptionstring or nullrequired

The description of the business, this is the description that will be shown to the public.

shortDescriptionstring or nullrequired

The short description of the business, this is the description that will be shown to the public.

websiteUrlstring or nullrequired

The website of the business, this is the website that will be shown to the public.

imageUrlstring or nullrequired

The image of the business, this is the image that will be shown to the public.

logoUrlstring or nullrequired

Logo URL for the business

streetAddressstring or nullrequired

The address of the business, this is the address that will be shown to the public.

phoneNumberstring or nullrequired

The phone number of the business.

neighborhoodstring or nullrequired

Neighborhood/area name (e.g., "West Bay", "Pearl Qatar", "Lusail") - auto-populated from geocoding

districtstring or nullrequired

District/administrative area - auto-populated from geocoding

citystring or nullrequired

The city of the business, this is the city that will be shown to the public.

postalCodestring or nullrequired

The postal code of the business, this is the postal code that will be shown to the public.

countrystring or nullrequired

The country of the business (auto-populated from geocoding if coordinates provided)

countryCodestring or nullrequired

ISO 3166-1 alpha-2 country code (e.g., QA, US, AE) - auto-populated from geocoding

Example:"QA"

coordsLatitudenumber or nullrequired

The latitude of the business, this is the latitude that will be shown to the public.

coordsLongitudenumber or nullrequired

The longitude of the business, this is the longitude that will be shown to the public.

businessTypeobject or null(BusinessTypeDTO)required

The business type of the business, this is the business type that will be shown to the public.

isActivebooleanrequired

The status of the business, this is the status that will be shown to the public.

approvalobject(ApprovalDTO)required

Approval metadata for this business.

canMintTokenbooleanrequired

The ability to mint token for the business, this is the ability that will be shown to the public.

Default:true

canChargeTokenbooleanrequired

The ability to charge token for the business, this is the ability that will be shown to the public.

Default:true

canManageUsersbooleanrequired

The ability to manage users for the business, this is the ability that will be shown to the public.

Default:true

canReceiveDonationbooleanrequired

The ability to receive donation for the business, this is the ability that will be shown to the public.

Default:true

tagsArray of stringsrequired

Tags for categorization and filtering

Default:[]

customDataobject or nullrequired

Custom business data including Google Places information (placeID, currentOpeningHours)

Example:

{
  "placeID": "ChIJN1t_tDeuEmsRUsoyG83frY4",
  "currentOpeningHours": {
    "open_now": true,
    "weekday_text": [ … ]
  }
}

accountAddressstring or nullrequireddeprecated

The address of the business, this is the address that will be shown to the public.

]

Response

[
  {
    "id": "string",
    "email": "string",
    "accountAddress": "string",
    "currentSigningAccountId": "string",
    "wallets": [ … ],
    "businessLegalName": "string",
    "registrationNumber": "string",
    "displayName": "string",
    "description": "string",
    "shortDescription": "string",
    "websiteUrl": "string",
    "imageUrl": "string",
    "logoUrl": "string",
    "streetAddress": "string",
    "phoneNumber": "string",
    "neighborhood": "string",
    "district": "string",
    "city": "string",
    "postalCode": "string",
    "country": "string",
    "countryCode": "QA",
    "coordsLatitude": 0,
    "coordsLongitude": 0,
    "businessType": { … },
    "isActive": true,
    "approval": { … },
    "canMintToken": true,
    "canChargeToken": true,
    "canManageUsers": true,
    "canReceiveDonation": true,
    "tags": [],
    "customData": { … }
  }
]