Returns a paginated list of renter groups within the API key's scope.

A renter is a RenterGroup — a household searching for a lettings property. The group has one
or more RenterProfile rows, each linking to a Person. Lettings properties the group has
been connected to via viewings, applications, or tenancies are reachable via the properties
link on the detail endpoint.

For fuzzy / typeahead lookup, use the /v2/search endpoint instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
0 to 2147483647
int32
1 to 100
uuid
string
enum
Allowed:
string
enum
Allowed:
boolean
boolean
uuid
int32
int32
date-time
date-time
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json