API Reference

Filter all Households

post
https://api.bridgeft.com/v2/reporting/households/filter

Return a filtered list of all Households

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

Number of items to return per page

integer

Current page number

Body Params
int64

Unique household identifier

string

Populated from custodian data but can be modified by users

integer

ID of the owning firm

string

See Entiti ID Prefixes

date

Date the household was opened

date

Date of household inception, if applicable. May differ from opening date

date | null

Date the household was closed, if applicable

string

See Account and Household Status Codes.

string

Short name for the household object

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago

Did this page help you?