Skip to main content

Get rental file status by metadata

GET 
/rental-files/resolve/status/

Retrieve only the status of a rental file by its metadata key and value.

This lightweight endpoint is optimized for performance and environmental impact:

  • Reduced Data Transfer: Only the status field is returned, minimizing network bandwidth usage.
  • Faster Responses: Projecting a minimal subset of fields accelerates database queries and response times.
  • Lower Resource Consumption: Smaller payloads and quicker operations reduce server CPU and memory usage, leading to lower energy consumption.

By isolating status retrieval from the full rental file data, clients can efficiently poll without incurring the cost of loading the entire document.

🔒 Authentication​

This endpoint require a valid OAuth2 Bearer

It supports account impersonation within Organization's sub-accounts using X-Eaz-Account-Id Header.

  • If the X-Eaz-Account-Id header is provided and the user has access rights to that sub-account, the impersonation context is applied.
  • Otherwise, the user's own account context is used.

Scopes :​

User must provide one of the following scopes:

  • admin
  • staff
  • user
  • org:admin
  • org:staff
  • org:user
  • rental_file:read

Request​

Responses​

Successful Response