Retrieve Households

get

https://example.com/households/

Returns a list of Households applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

case

integer

Filter via case ID. Must supply integer value, cannot search by case name or other field information.

order_by

string

Order results by a field name. Prefix with - for descending order. eg. order_by=mod_date for ascending or order_by=-mod_date for descending. Must be a valid field on the resource; an invalid field returns a 400 error.

entry_agent

integer

Filter by the ID of the agent who created the household record.

mod_agent

integer

Filter by the ID of the agent who last modified the household record.

county

integer

Filter by county ID. Must supply integer value.

address

string

Filter via street address. Wildcards supported. e.g. address=B% will return all records beginning with 'B'. Do not use quotations like address="B%".

city

string

Filter via city. Wildcards supported. e.g. city=B% will return all records beginning with 'B'. Do not use quotations like city="B%".

state

string

Filter via state. Wildcards supported. e.g. state=B% will return all records beginning with 'B'. Do not use quotations like state="B%".

zip_code

string

Filter via zip code. Wildcards supported. e.g. zip_code=B% will return all records beginning with 'B'. Do not use quotations like zip_code="B%".

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200search results matching criteria