Skip to main content
Version: 2.0

List

List

This endpoint returns a paginated list of businesses created within a specified date range. Use this to audit your business records, check active/inactive status, or build a directory view within your application.

In the request JSON, you must provide the date range and the number of businesses you want to be listed on each page.

GET business/list 

Request Body

FieldTypeDescription
BusinessIdGUIDUnique identifier of the business. Required if PayerRef is not provided
PayerRefStringYour unique identifier for the payer.
TINStringTaxpayer identification number of the business
TINTypeStringTIN type of the business.
IsActiveBooleanOptional When TRUE, only active businesses are returned in the response. When FALSE, only deactivated businesses are returned.
Last4DigitStringOptional Filter by the last 4 digits of the business TIN
FromDateStringOptional Return businesses created on or after this date.
Format: MM/DD/YYYY
ToDateStringOptional Return businesses created on or before this date.
Format: MM/DD/YYYY
PageintPage number to retrieve. Starts at 1.
PageSizeintNumber of records per page. Maximum: 100

Response Body

FieldTypeDescription
BusinessesObject[]Array of matching business records.
BusinessIdGUIDTaxBandits-generated unique identifier of the business.
PayerRefStringYour unique identifier for the business.
IsDefaultBusinessBooleanIdentifies whether this is the default business.
IsActiveBooleanGets the active status of the business
TINDetailsObjectTIN details of the business.
FormatStringTIN format used for this business.
TINTypeStringTIN type of the business.
TINStringTaxpayer identification number of the business.
IndividualNmObjectIf the TINType is SSN
FirstNmStringFirst name of the individual.
MiddleNmStringMiddle name of the individual.
LastNmStringLast name of the individual.
SuffixStringSuffix of the individual's name
BusinessNmStringName of the business.
NameCtrlStringName control of the business.
DBADetailsObjectDBA details of the business.
DBANmStringName of the DBA.
DBARefStringYour unique identifier for the DBA.
DBAIdGUIDTaxBandits-generated unique identifier of the DBA.
AddressObjectAddress details of the DBA
Address1StringStreet address or PO Box of the DBA.
Address2StringSuite or apartment of the DBA.
CityStringCity of the DBA.
ProvinceOrStateStringProvince or state name of the DBA.
ZipCdStringZIP code of the DBA.
CountryStringCountry code of the DBA.
AddressobjectAddress of the business
Address1StringStreet address or PO Box of the business.
Address2StringSuite or apartment of the business.
CityStringCity of the business.
ProvinceOrStateStringProvince or state name of the business.
ZipCdStringZIP code of the business.
CountryStringCountry code of the business.
PagenumberRequested page number.
TotalRecordsnumberTotal number of records returned in the response.
TotalPagesnumberNumber of pages with records.
PageSizenumberRequested page size.
Errorsobject[]Top-level request errors if the entire request cannot be processed
IdstringValidation error code
NamestringName of the validation rule that failed
MessagestringDescription of what went wrong
Request Json
SampleDescriptionAction
Sample 1
List businesses using active status, TIN, date range, and pagination filters.
Sample 1
business/list?businessId=eb110a4f-21ed-421d-be74-c20fe16c86ef&IsActive=true&Last4Digit=4484&FromDate=04/20/2026&ToDate=04/21/2026&Page=62&PageSize=10&PayerRef=Pe67242
Response Json
SampleDescriptionAction
200
Success Response - This is a sample response for successful API requests.
400
Bad Request Response - You'll get the below response when your API requests contain any validation errors.
{
"Businesses": [
{
"BusinessId": "eb110a4f-21ed-421d-be74-c20fe16c86ef",
"PayerRef": "Pe77162",
"IsDefaultBusiness": false,
"IsActive": true,
"TINDetails": {
"TINType": "EIN",
"Last4Digit": "4484",
"TINMatchStatus": null
},
"IndividualNm": null,
"BusinessNm": "O'Reilly Group",
"NameCtrl": "SNOW",
"DBADetails": {
"DBANm": "Iceberg Icecreams",
"DBARef": "DBA1001",
"DBAId": "ce1f01ce-e680-4768-abd0-7bcd75185430"
},
"Email": "james@sample.com",
"Address": {
"Address1": "123 Main St",
"Address2": "Suite 1001",
"City": "Rock Hill",
"ProvinceOrState": "SC",
"ZipCd": "29730",
"Country": "US"
},
"CreatedTime": "2026-07-07 09:07:29 -04:00",
"LastUpdatedTime": "2026-07-07 09:07:29 -04:00"
}
],
"Page": 1,
"PageSize": 100,
"TotalRecords": 1,
"TotalPages": 1,
"Errors": null
}