{ "opencollection": "1.0.0", "info": { "name": "RentCheck REST Account Settings Properties V3 API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Properties V3", "type": "folder" }, "items": [ { "info": { "name": "Get all buildings (v3 digest)", "type": "http" }, "http": { "method": "GET", "url": "https://prod-public-api.getrentcheck.com/v3/properties/buildings", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "The number of elements in the data collection. Sizes above `250` are clamped to `250` to keep responses bounded (matches the API-wide pagination policy documented in the OpenAPI intro)." }, { "name": "page_number", "value": "", "type": "query", "description": "Zero-indexed page number." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort results by one of the available fields." }, { "name": "sort_type", "value": "", "type": "query", "description": "Sort direction. Case-insensitive, so `asc`/`ASC`/`Asc` and `desc`/`DESC`/`Desc` are all accepted." }, { "name": "search", "value": "", "type": "query", "description": "Search string to match building addresses." }, { "name": "filters[team][value]", "value": "", "type": "query", "description": "List of team ids to filter by. Multiple values are concatenated with `|`. When `filters[team][condition]` is supplied, this must resolve to at least one id, so an empty list surfaces as 400 `\"filters.teamIds.value\" must contain at least 1 items`." }, { "name": "filters[team][condition]", "value": "", "type": "query", "description": "Condition to apply to the team filter." }, { "name": "team_id[]", "value": "", "type": "query", "description": "Legacy team id filter. Prefer `filters[team][value]`." }, { "name": "last_completed_inspection_start_date", "value": "", "type": "query", "description": "ISO-8601 date (`YYYY-MM-DD`) or date-time lower bound for the last completed inspection filter. Both date and date-time forms are accepted, and an empty string is treated as \"no filter\"." }, { "name": "last_completed_inspection_end_date", "value": "", "type": "query", "description": "ISO-8601 date (`YYYY-MM-DD`) or date-time upper bound for the last completed inspection filter. Both date and date-time forms are accepted, and an empty string is treated as \"no filter\"." }, { "name": "synced", "value": "", "type": "query", "description": "Filter by external integration sync status." }, { "name": "extra_fields[]", "value": "", "type": "query", "description": "Optional list of extra fields to include in each digest (e.g. `last_completed_inspection`)." } ] }, "docs": "Returns a paginated list of building property digests. V3 returns a trimmed `api_property_digest`\nprojection and uses the `filters[team][value|condition]` syntax (with the legacy `team_id[]` parameter\nstill accepted).\n" }, { "info": { "name": "Get all communities (v3 digest)", "type": "http" }, "http": { "method": "GET", "url": "https://prod-public-api.getrentcheck.com/v3/properties/communities", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "The number of elements in the data collection. Sizes above `250` are clamped to `250` to keep responses bounded (matches the API-wide pagination policy documented in the OpenAPI intro)." }, { "name": "page_number", "value": "", "type": "query", "description": "Zero-indexed page number." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort results by one of the available fields." }, { "name": "sort_type", "value": "", "type": "query", "description": "Sort direction. Case-insensitive, so `asc`/`ASC`/`Asc` and `desc`/`DESC`/`Desc` are all accepted." }, { "name": "search", "value": "", "type": "query", "description": "Search string to match community addresses." }, { "name": "filters[team][value]", "value": "", "type": "query", "description": "List of team ids to filter by. Multiple values are concatenated with `|`. When `filters[team][condition]` is supplied, this must resolve to at least one id, so an empty list surfaces as 400 `\"filters.teamIds.value\" must contain at least 1 items`." }, { "name": "filters[team][condition]", "value": "", "type": "query", "description": "Condition to apply to the team filter." }, { "name": "team_id[]", "value": "", "type": "query", "description": "Legacy team id filter. Prefer `filters[team][value]`." }, { "name": "last_completed_inspection_start_date", "value": "", "type": "query", "description": "ISO-8601 date (`YYYY-MM-DD`) or date-time lower bound for the last completed inspection filter. Both date and date-time forms are accepted, and an empty string is treated as \"no filter\"." }, { "name": "last_completed_inspection_end_date", "value": "", "type": "query", "description": "ISO-8601 date (`YYYY-MM-DD`) or date-time upper bound for the last completed inspection filter. Both date and date-time forms are accepted, and an empty string is treated as \"no filter\"." }, { "name": "synced", "value": "", "type": "query", "description": "Filter by external integration sync status." }, { "name": "extra_fields[]", "value": "", "type": "query", "description": "Optional list of extra fields to include in each digest (e.g. `last_completed_inspection`)." } ] }, "docs": "Returns a paginated list of community property digests. Uses the same filter / pagination shape as\n`/v3/properties/buildings` and `/v3/properties/units`.\n" }, { "info": { "name": "Get all units (v3 digest)", "type": "http" }, "http": { "method": "GET", "url": "https://prod-public-api.getrentcheck.com/v3/properties/units", "params": [ { "name": "page_size", "value": "", "type": "query", "description": "The number of elements in the data collection. Sizes above `250` are clamped to `250` to keep responses bounded (matches the API-wide pagination policy documented in the OpenAPI intro)." }, { "name": "page_number", "value": "", "type": "query", "description": "Zero-indexed page number." }, { "name": "sort_by", "value": "", "type": "query", "description": "Sort results by one of the available fields." }, { "name": "sort_type", "value": "", "type": "query", "description": "Sort direction. Case-insensitive, so `asc`/`ASC`/`Asc` and `desc`/`DESC`/`Desc` are all accepted." }, { "name": "search", "value": "", "type": "query", "description": "Search string to match unit addresses." }, { "name": "filters[team][value]", "value": "", "type": "query", "description": "List of team ids to filter by. Multiple values are concatenated with `|`. When `filters[team][condition]` is supplied, this must resolve to at least one id, so an empty list surfaces as 400 `\"filters.teamIds.value\" must contain at least 1 items`." }, { "name": "filters[team][condition]", "value": "", "type": "query", "description": "Condition to apply to the team filter." }, { "name": "team_id[]", "value": "", "type": "query", "description": "Legacy team id filter. Prefer `filters[team][value]`." }, { "name": "last_completed_inspection_start_date", "value": "", "type": "query", "description": "ISO-8601 date (`YYYY-MM-DD`) or date-time lower bound for the last completed inspection filter. Both date and date-time forms are accepted, and an empty string is treated as \"no filter\"." }, { "name": "last_completed_inspection_end_date", "value": "", "type": "query", "description": "ISO-8601 date (`YYYY-MM-DD`) or date-time upper bound for the last completed inspection filter. Both date and date-time forms are accepted, and an empty string is treated as \"no filter\"." }, { "name": "synced", "value": "", "type": "query", "description": "Filter by external integration sync status." }, { "name": "extra_fields[]", "value": "", "type": "query", "description": "Optional list of extra fields to include in each digest (e.g. `last_completed_inspection`)." } ] }, "docs": "Returns a paginated list of unit property digests. Uses the same filter / pagination shape as\n`/v3/properties/buildings` and `/v3/properties/communities`.\n" }, { "info": { "name": "Get property permissions for the current user", "type": "http" }, "http": { "method": "GET", "url": "https://prod-public-api.getrentcheck.com/v3/properties/permissions" }, "docs": "Returns the property-level permissions that drive the RentCheck app UI (e.g. whether the user can\ntrigger bulk unit imports). Used internally by the mobile and web apps.\n" } ] } ], "bundled": true }