API conventions

Use these conventions when you build against the Roots UAT API and prepare for production contract changes.

See API availability for resource status and target-schema differences.

Base URL

Send UAT requests to:

https://api.uat.roots.finance

Pagination

The published list endpoints use page-based request parameters and offset-based response metadata.

List responses return this envelope:

{
  "total": 1,
  "items": [],
  "limit": 20,
  "offset": 0
}

Use page and page_size to request data. Use total, limit, and offset to display progress or calculate whether more results are available. Do not derive an offset request parameter unless Roots publishes one.

Current enum values

Use the values published in the current API schema exactly. They are case-sensitive.

Target schema — confirm in API reference

Roots recommends a lowercase snake_case convention for future public enums, for example in_review, rfi_required, and company_admin.

This is a pre-GA schema recommendation, not a released change. Do not transform current enum values in requests or responses until Roots publishes an updated API contract and migration guidance.

Amounts and precision

The current payment schema accepts amount as a JSON number. Send the decimal value required by the published schema and reconcile the exact value returned by Roots.

Do not assume minor-unit integers, an implicit rounding mode, or a supported decimal scale. Confirm precision and rounding behavior before production money movement.

Next steps

• Read Errors for documented error handling.
• Read API availability for current and target resource states.
• Read Create payments for payment-purpose values and payment lifecycle handling.