HIhifibridge
User

List all users

Get all existing Hifi users

get/v2/users

Request

Query parameters

type'individual' | 'business'

If passed, you will get all users under the type.

firstNamestring

If passed, you will get all users with the case-insensitive partial match of firstName.

lastNamestring

If passed, you will get all users with the case-insensitive partial match of lastName.

businessNamestring

If passed, you will get all users with the case-insensitive partial match of businessName.

emailstring

If passed, you will get all users with the case-insensitive partial match of email.

limitstring

default to 10, maximum to 100

createdBeforestring date

ISO format: YYYY-MM-DD

createdAfterstring date

ISO format: YYYY-MM-DD

Response

Success

countinteger
nextCursorstring

The createdAt timestamp of the last record in the current page. Pass this as createdBefore in the next request to retrieve the next page of results.

Changes

No recorded changes to this operation across all 1 revision of this API.