Skip to main content
Welcome to the Mortgage CRM API reference. This section covers the core concepts you need before diving into endpoints.

​
Base URL

https://mortgage-crm.universal.rollout.com/api

​
Authentication (at a glance)

All requests require an Authorization header with a Bearer token (your authToken). For Mortgage CRM endpoints that operate on a connected account, include X-Rollout-Credential-Id as well.

​
Data types and sync settings

Optional data types must be enabled on the credential before you use endpoints that require them. See Choose what data to sync for defaults, connector support, and configuration. If a request says the credential is configured not to sync an entity, follow the troubleshooting guide.

​
Write behavior and propagation

Writes apply only to the system tied to the credential you provide in X-Rollout-Credential-Id. Rollout does not automatically propagate writes to other systems. If you need multi-system sync, call each credential explicitly or use Sync to DB plus your own orchestration.

​
Response shape

List endpoints typically return a data array plus a _metadata object with pagination details like offset, limit, total, next, and nextLink when available.

​
Next steps

  • Read Authentication for header details and example requests.
  • See Pagination for how list endpoints are navigated.
  • Review Errors for status codes and error payloads.