Skip to Content
Home

API Access

Please contact dev@simpl.rent to obtain API access or with any additional requests and questions.

When enabled it is possible to generate and rotate API key from simpl.rent dashboard.

Integration

  • Integrations must allow for API extensions by default.
  • Extensions may include new nodes or node attributes.

Breaking Changes

  • API endpoints may be modified, deprecated, or removed without backward compatibility.
  • All clients will be notified via email in advance of such changes.

Errors

Errors are returned with an HTTP status code and a JSON body:

Error Example
{
    "status": 400,
    "message": "Provide complete granular address fields (city, street, houseNumber, postalCode)",
    "timestamp": "2026-01-01 12:00:00"
}

When request validation fails, message contains the first validation error.

Common status codes:

  • 400 - the request is invalid (missing or incorrect fields, unsupported values, operation not allowed in the current state).
  • 401 - the API key is missing or invalid, or the user identified by UserID has not granted access.
  • 403 - the account is not allowed to perform the operation or is disabled.
  • 404 - the requested resource does not exist.
  • 409 - the request conflicts with existing data (for example a duplicate referenceId).
  • 500 - unexpected server error.

Conventions

  • Field names use camelCase.
  • Fields without a value are omitted from responses and callbacks - they are absent rather than null.
  • Dates use the yyyy-MM-dd format and timestamps use the yyyy-MM-ddTHH:mm:ss.SSSSSS format in UTC.

Callbacks

  • Callbacks are sent only for resources created with a callbackUrl.
  • A callback is an HTTP POST request with a JSON body and the Content-Type: application/json header.
  • Respond with a 2xx status code to acknowledge a callback - other responses are retried.
Authorization