GET /v1/renters — list renters in your org

The /v1/renters endpoint returns a list of renter records associated with your organization in RentFAX. You can use this to build dashboards, sync renter data to your own database, or audit which renters your team has on file. Each item in the response includes the full renter data object, prefixed with its id.

This endpoint returns at most 50 records per call and does not currently support cursor-based pagination. If your organization has more than 50 renters, contact support for bulk export options.

Endpoint

GET https://api.rentfax.io/v1/renters

Authentication

This endpoint requires the x-api-key header. Bearer token authentication is not accepted here.

x-api-key: <your-api-key>

If the key is missing or invalid, the API returns 401 Unauthorized.

Query parameters

orgId

string

required

Your organization’s RentFAX ID. Results are scoped to renters belonging to your organization.

Response

The response is a JSON array. Each element is the renter’s stored data object with the document id field added at the top level.

string

The renter’s unique ID within your organization. Use this as renter_id when calling /v1/renter/score.

[...data fields]

object

All fields stored on the renter record. The exact set of fields depends on how the renter was created, but typically includes name, email, phone, verification status, and risk score data.

Example

cURL

curl --request GET \
  --url "https://api.rentfax.io/v1/renters?orgId=org_4a8c2f91b" \
  --header "x-api-key: rfx_live_your_api_key_here"

Response

[
  {
    "id": "rtr_7f3a92c1d8e04b6f",
    "memberId": "MBR-00291847",
    "fullName": "Jane Doe",
    "email": "jane.doe@example.com",
    "phone": "+15558675309",
    "verified": true,
    "verificationLevel": "IDENTITY_VERIFIED",
    "rentScore": 847,
    "fraudReported": false,
    "totalRentals": 14,
    "riskFlags": ["LATE_RETURN"],
    "createdAt": "2024-03-12T09:00:00.000Z"
  },
  {
    "id": "rtr_2b6e14d0a73f5c81",
    "memberId": "MBR-00388214",
    "fullName": "Marcus Webb",
    "email": "mwebb@example.com",
    "phone": "+15552049183",
    "verified": false,
    "verificationLevel": "UNVERIFIED",
    "rentScore": 540,
    "fraudReported": false,
    "totalRentals": 3,
    "riskFlags": [],
    "createdAt": "2025-01-07T14:33:00.000Z"
  }
]

To get a detailed risk score for a specific renter, pass their id as renter_id to GET /v1/renter/score.

Overview

Renters

Reports & Incidents

Webhooks

GET /v1/renters — list renters in your org

Endpoint

Authentication

Query parameters

Response

Example

Response

​Endpoint

​Authentication

​Query parameters

​Response

​Example

​Response

Endpoint

Authentication

Query parameters

Response

Example

Response