API Overview

The re-base.io API exposes organization-scoped resources over HTTPS. Use it for approved server-to-server integrations that need properties, assignments, clients, files, API key management, or reference data.

The signed-in API Explorer is the source of truth for the currently published paths, request schemas, and response schemas.

Base URL

Production requests use:

https://api.re-base.io

Local development normally uses https://localhost:4000. Never point test automation at production, and do not move credentials between environments.

Resource paths use the /api prefix. For example:

curl --request GET \
  --url 'https://api.re-base.io/api/properties?page=1&limit=20' \
  --header 'x-api-key: ap_live_REPLACE_ME'

Published Resource Families

Family	Typical work
Properties	List, create, review, and update property records.
Assignments	Work with appraisal assignments and supported assignment relationships.
Clients	Work with client organizations and contacts.
Files	Upload, inspect, download, and attach supported files.
Reference Data	Read enums and supported designation/reference values.
API Keys	Manage organization keys when the caller has admin permission.

Not every application screen is a public integration contract. If a path is absent from the developer OpenAPI document, treat it as internal even if the web application calls it.

Conventions

Send and accept JSON unless an upload operation documents multipart data.
IDs are generally UUID strings; use the schema shown for the operation.
Dates and timestamps use ISO 8601 strings.
Collection routes use page-based pagination. See Pagination.
Record access is constrained by organization, role, key scope, and record restrictions.

Pagination

Published collection routes generally accept page and limit query parameters and return:

{
  "items": [],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 0,
    "pages": 0
  }
}

Use the exact response schema in the Explorer: a small number of custom routes wrap data in the standard { "success": true, "data": ... } envelope.

Integration Boundaries

re-base.io does not currently publish an official SDK or a customer-configurable outbound event webhook contract. Use a maintained HTTP client in your language, and build only against operations present in the published OpenAPI document.