List users
GET/v1/businesses/{businessId}/users
Lists the users on the business.
The business must have completed verification (ACTIVE or
INACTIVE); one still UNDER_REVIEW or in NEEDS_ATTENTION returns
409.
Path Parameters
businessId string<uuid>required
The ID of the business, assigned by Hiya.
Example:
9b8a1c4e-2c0f-4f3d-9a1e-7b3a2b4c6d8fResponses
- 200
- 401
- 404
- 409
- 500
The business's users.
Response Body
The API key is missing or invalid.
Response Body
No business with that ID exists, or it isn't one of yours — the two are indistinguishable by design.
Response Body
The business hasn't completed verification. Returned as
CONFLICT.
Response Body
Something went wrong on our side.
Response Body