Get all businesses
GET/business
Provides all details for all businesses accessible to your account in an array. The response will include current status on the business vetting process.
Responses
- 200
- 401
- 404
- 500
OK
Response Body
Array [
]
businessesobject[]required
Persistent ID assigned to this business
11111111-1111-1111-1111-111111111111Legal registered name of the business
Sample Business Inc.Primary DBA / public business name
Sample BusinessWhile DUNS number is optional in the API, the service might decline businesses without a DUNS number depending on the API key configuration. If DUNS is provided, Hiya will verify the business information against the DUNS record on file, even if DUNS is optional.
123456789GB123456789Primary country of operation for business headquarters. Provide as an ISO-3166-1 alpha-2 country code, for example “US”, “GB”, “DE”.
GBState/province or similar of the business headquarters. IMPORTANT: This field is required for businesses registered in either US or CA, using the two-character territory code (BC, ON, QB or similar) or the two-character state code (WA, NY, PR or similar).
West YorkshireLeedsLS1123 Any St.Suite 200Primary industry of operations by this business (not limited to only industry purpose that creates phone calls)
industry (string)Possible values: [ACCOUNTING_OR_FINANCE, BILLING_AND_COLLECTIONS, BUSINESS_SERVICES, CHARITY_OR_FUNDRAISING, COMMUNICATIONS, CUSTOMER_SERVICE, DELIVERY_OR_SHIPPING, EDUCATION, FINANCIAL_SERVICES, GOVERNMENT_OR_PUBLIC_SERVICES, HEALTHCARE_OR_PHARMACY, INSURANCE, LEGAL_SERVICES, NOTIFICATIONS_OR_SCHEDULING, REAL_ESTATE, RETAIL, SALES, SOFTWARE_OR_TECHNOLOGY_OR_MEDIA, SURVEYS_AND_MARKET_RESEARCH, TRAVEL_OR_HOSPITALITY, OTHER]
ACCOUNTING_OR_FINANCEcontactobject
Name, email address, phone number, and job title of a representative at the business
SamplePersonsample@sample.comCEO+4412345678990NumberOfEmployees (string)Possible values: [BETWEEN_1_AND_10, BETWEEN_11_AND_50, BETWEEN_51_AND_200, BETWEEN_201_AND_500, BETWEEN_501_AND_2000, BETWEEN_2001_AND_10000, MORE_THAN_10001]
BETWEEN_1_AND_10Primary website (will be used in business verification)
www.hiya.comTime when this business record was created
string<date-time>2026-02-02T08:30:00ZLast time that any information changed for this business
string<date-time>2026-02-02T08:45:00ZCurrent status of the registration process for the business. “pending” indicates registration is still in progress. “registered” indicates registration is complete and the business may now have registered phone numbers.
“error_duns_mismatch” indicates that the provided business information did not align with the business information on record for the provided DUNS number; update the business information to attempt registration again.
Possible values: [pending, registered, error_duns_mismatch]
pendingQuantity of registered phone numbers for this business (does not include phone numbers that failed to register.)
integer<int32>10Example from Schema
{
"businesses": [
{
"businessId": "11111111-1111-1111-1111-111111111111",
"legalName": "Sample Business Inc.",
"primaryName": "Sample Business",
"dunsNumber": "123456789",
"einVatNumber": "GB123456789",
"country": "GB",
"region": "West Yorkshire",
"city": "Leeds",
"postcode": "LS1",
"streetAddressLine1": "123 Any St.",
"streetAddressLine2": "Suite 200",
"industry": "ACCOUNTING_OR_FINANCE",
"contact": {
"firstName": "Sample",
"lastName": "Person",
"email": "sample@sample.com",
"title": "CEO",
"phone": "+4412345678990"
},
"numberOfEmployees": "BETWEEN_1_AND_10",
"website": "www.hiya.com",
"registered": "2026-02-02T08:30:00Z",
"updated": "2026-02-02T08:45:00Z",
"status": "pending",
"registeredTns": 10
}
]
}
Unauthorized
Response Body
Array [
]
The unique identifier for the request. This ID can be used to track the request and its associated response.
The timestamp when the request was processed. This field indicates the exact time at which the response was generated.
string<date-time>errorsobject[]required
A list of errors that occurred during the processing of the request. This field provides detailed information about any issues encountered.
The error code that indicates the type of error that occurred. This field provides a standardized way to identify specific errors in the response.
Possible values: [INTERNAL_SERVER_ERROR, MISSING_REQUIRED_FIELD, INVALID_FIELD, DOMAIN_MISMATCH, UNAUTHORIZED, BUSINESS_ALREADY_EXISTS, BUSINESS_NOT_FOUND, BAD_REQUEST]
A human-readable description of the error. This field provides additional context or information about the error that occurred.
Example from Schema
{
"requestId": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"description": "string"
}
]
}
Not Found
Response Body
Array [
]
The unique identifier for the request. This ID can be used to track the request and its associated response.
The timestamp when the request was processed. This field indicates the exact time at which the response was generated.
string<date-time>errorsobject[]required
A list of errors that occurred during the processing of the request. This field provides detailed information about any issues encountered.
The error code that indicates the type of error that occurred. This field provides a standardized way to identify specific errors in the response.
Possible values: [INTERNAL_SERVER_ERROR, MISSING_REQUIRED_FIELD, INVALID_FIELD, DOMAIN_MISMATCH, UNAUTHORIZED, BUSINESS_ALREADY_EXISTS, BUSINESS_NOT_FOUND, BAD_REQUEST]
A human-readable description of the error. This field provides additional context or information about the error that occurred.
Example from Schema
{
"requestId": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"description": "string"
}
]
}
Internal Server Error
Response Body
Array [
]
The unique identifier for the request. This ID can be used to track the request and its associated response.
The timestamp when the request was processed. This field indicates the exact time at which the response was generated.
string<date-time>errorsobject[]required
A list of errors that occurred during the processing of the request. This field provides detailed information about any issues encountered.
The error code that indicates the type of error that occurred. This field provides a standardized way to identify specific errors in the response.
Possible values: [INTERNAL_SERVER_ERROR, MISSING_REQUIRED_FIELD, INVALID_FIELD, DOMAIN_MISMATCH, UNAUTHORIZED, BUSINESS_ALREADY_EXISTS, BUSINESS_NOT_FOUND, BAD_REQUEST]
A human-readable description of the error. This field provides additional context or information about the error that occurred.
Example from Schema
{
"requestId": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"description": "string"
}
]
}