RentCheck Users API declares
3 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
An API key is passed in the header as x-app-id (x-app-id).
An API key is passed in the header as x-app-secret (x-app-secret).
By default, every request must be authenticated.
bearerAuth — Authorization key needed to use the API
x-app-id — Represents the identification of you application
x-app-secret — Represents the secret for your application
Paths & Operations 27
Across 20 paths, the API surfaces 27 operations — 3 DELETE, 13 GET, 3 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
Users 27
GET
/v1/intercom/articles
List Intercom help-center articles under a parent collection or section
3 params→ 200400401
GET
/v1/intercom/messenger-jwt
Mint an Intercom Messenger JWT for the caller
1 param→ 200400401404500
PUT
/v1/intercom/users/companies
Attach the caller to an Intercom company
body→ 200400401404
DELETE
/v1/me/fcm-token
Clear the caller's FCM device tokens
→ 200401404
PUT
/v1/me/fcm-token
Register an FCM device token for the caller
body→ 200400401404
DELETE
/v1/me
Disable the authenticated user
→ 204401404
GET
/v1/me
Get the authenticated user
→ 200401404
PUT
/v1/me
Update the authenticated user
body→ 200400401
GET
/v1/me/firebase-token
Mint a Firebase custom auth token for the caller
→ 200401
GET
/v1/me/notifications-preferences
Get the caller's personal notifications preferences
→ 200401
PUT
/v1/me/notifications-preferences
Update the caller's personal notifications preferences
body→ 200400401
GET
/v1/me/settings
Get the authenticated user's settings
→ 200401404
PUT
/v1/me/settings
Update the authenticated user's settings
body→ 200400401404
GET
/v1/me/subscriptions/notifications-preferences
Get the subscription-level notifications preferences for the caller
→ 200401
PUT
/v1/me/subscriptions/notifications-preferences
Update the subscription-level notifications preferences for the caller
body→ 200400401403
GET
/v1/me/integration-token
Get the caller's long-lived integration token
→ 200401404
POST
/v1/me/link-with-tenant
Link the authenticated user to a tenant record
body→ 204400401404
GET
/v1/me/metabase-embed-token
Mint a Metabase static-embedding token for Resident Insights
→ 200401403404
GET
/v1/me/pm-contact-info
Get the caller's property manager contact info
→ 200400401404
GET
/v1/me/requests
Get the caller's pending inspection requests
→ 200401
PUT
/v1/users/permission-groups
Bulk-edit users' permission groups
body→ 200400401
POST
/v1/users
Create a user account
body→ 200400
GET
/v1/users
Get all users
8 params→ 200401
DELETE
/v1/users/{userId}
Deactivate a user
1 param→ 204401403404
GET
/v1/users/{id}
Get a user by ID
1 param→ 200401404
POST
/v1/users/invite
Invite users
body→ 200400401
PUT
/v1/users/{userId}/access
Update a user's team and permission group access
1 parambody→ 200400401404
Schemas 30
The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are api_user (16 properties), api_intercom_article (14 properties), api_user_metadata (14 properties), api_inspection_request (9 properties). Each schema is shown below with its type and property counts.
api_user_team_digest
object
4 properties4 required
me_link_with_tenant_request_model
object
Request body for linking the caller to a tenant record via an invite.
1 property1 required
api_inspection_request
object
9 properties8 required
api_user_external_identities
object
Third-party identity verification payloads. Keys are provider-specific.
1 property
me_get_user_requests_response_model
array
Inspection requests pending action from the caller.
intercom_messenger_jwt_response_model
object
Short-lived signed JWT used by the Intercom Messenger client to authenticate the caller.
1 property1 required
api_user_metadata
object
Per-user metadata document tracking onboarding dismissals, view-mode preferences and other UI state.
14 properties2 required
user_create_response_model
object
2 properties
user_get_by_id_response_model
object
5 properties
me_get_integration_token_response_model
object
1 property1 required
notification_preference
object
2 properties1 required
intercom_update_companies_response_model
object
Result of attaching the caller to the requested Intercom company and refreshing their custom attributes. Both fields proxy the Intercom REST API response and a…
2 properties
me_get_metabase_embed_token_response_model
object
Envelope for GET /v1/me/metabase-embed-token. Returns { token } wrapped in the standard { data } shape.
2 properties2 required
user_update_access_request_model
object
3 properties3 required
me_update_request_model
object
Partial update for the authenticated user. Email or password changes require currentpassword.
9 properties
api_user_digest
object
7 properties7 required
notifications_preferences_update_request_model
object
Partial update — any combination of the fields on the preferences document may be provided. Server merges the supplied values onto the current preferences.
4 properties
me_update_fcm_token_request_model
object
Request body for registering an FCM device token.
1 property1 required
me_update_settings_request_model
object
Partial update for the authenticated user's metadata / preferences.
8 properties
me_get_pm_contact_info_response_model
object
Property manager contact info exposed to a linked renter.
3 properties3 required
user_bulk_edit_permission_groups_request_model
object
2 properties2 required
user_invite_response_model
object
2 properties2 required
notifications_preferences_response_model
object
8 properties5 required
intercom_update_companies_request_model
object
Attaches the caller to the given Intercom company.
1 property1 required
api_user
object
Full user document for the authenticated caller.
16 properties11 required
user_create_request_model
object
8 properties5 required
user_invite_request_model
object
4 properties4 required
me_get_firebase_token_response_model
object
1 property1 required
notification_preference_no_email
object
1 property1 required
api_intercom_article
object
Intercom Help Center article record — a direct pass-through of the Intercom articles REST resource, cached by the RentCheck backend.
14 properties12 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
