GET
List renters

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

Case-insensitive substring match on name, phone, email, or identity number

Maximum string length: 160
phone
string

Exact phone match

Maximum string length: 40
email
string

Case-insensitive exact email match

Maximum string length: 160
identity_number
string

Exact identity number match

Maximum string length: 80
include_archived
boolean

Include archived renters (default false)

limit
integer<int64>

Page size 1-500 (default 100)

Required range: 1 <= x <= 500
offset
integer<int64>

Page offset (default 0)

Required range: x >= 0

Response

Renters

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.