Skip to main content

Get rental file by metadata

GET 
/rental-files/resolve/

Retrieve a rental file by its metadata key and value.

This endpoint allows clients to fetch a single rental file within their tenant based on a metadata field. It supports dot-notation for nested fields, enabling queries on sub-keys (e.g., internal_data.id).

Example:

A rental file with the following metadata:

{
    "internals": {
        "id": "12343",
        "reference": "AZXZ1"
    }
}

Can be retrieved by:

GET /get-by-metadata/?meta_key=internals.id&meta_value=12343

or

GET /get-by-metadata/?meta_key=internals.id&meta_value=AZXZ1
warning

Our system doesn't enforce the uniqueness of your IDs. In case of duplicated objects that match your query, only one will be returned.

🔒 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