Rental Asset Profiles GET API Documentation

Purpose

This API is used to retrieve a list of rental asset profiles configured in the system. Each rental asset profile represents a pricing and availability configuration that can be associated with one or more rental assets, including session-based pricing, availability schedules, tax configuration, and booking limits.

Use Case

This endpoint is commonly used by booking systems, administrative dashboards, and asset management modules to display available rental asset profiles along with their linked rental assets, session pricing rules, availability schedules, and pagination details for large datasets.

Path Parameters

This endpoint does not require path parameters

Query Parameters

Attribute	Type	Description
limit	Integer	Number of records to return per page
offset	Integer	Number of records to skip for pagination

Request Body

This endpoint does not accept a request body

Response

On successful execution, the API returns a paginated list of rental asset profiles. Each profile includes core profile details, tax configuration, associated rental assets, session definitions, pricing rules, availability schedules, and audit metadata. The response also contains pagination information to support incremental data retrieval for large result sets.

Response Body

                JSON
              

                      {
  "rental_asset_profiles": [
    {
      "status": "STATUS",
      "uuid": "RENTAL_ASSET_PROFILE_UUID",
      "name": "PROFILE_NAME",
      "display_name": "PROFILE_DISPLAY_NAME",
      "max_booking_limit": "MAX_BOOKING_LIMIT",
      "tax_inclusive": "BOOLEAN",
      "currency": "CURRENCY_CODE",
      "tax": {
        "uuid": "TAX_UUID",
        "code": "TAX_CODE",
        "rate": "TAX_RATE",
        "link": "TAX_LINK"
      },
      "created_by": "CREATED_BY",
      "created_on": "CREATED_TIMESTAMP",
      "last_updated_by": "UPDATED_BY",
      "last_updated_on": "LAST_UPDATED_TIMESTAMP",
      "rental_assets": [
        {
          "status": "STATUS",
          "uuid": "RENTAL_ASSET_UUID",
          "name": "RENTAL_ASSET_NAME",
          "display_name": "RENTAL_ASSET_DISPLAY_NAME",
          "image_name": "IMAGE_NAME",
          "use_custom_availability": "BOOLEAN",
          "link": "RENTAL_ASSET_LINK"
        }
      ],
      "rental_asset_profile_sessions": [
        {
          "status": "STATUS",
          "uuid": "SESSION_UUID",
          "name": "SESSION_NAME",
          "start_date": "START_DATE",
          "end_date": "END_DATE",
          "rental_asset_profile_session_prices": [
            {
              "id": "ID",
              "status": "STATUS",
              "uuid": "PRICE_UUID",
              "price": "PRICE",
              "enabled_pro_rata": "BOOLEAN",
              "price_type": "PRICE_TYPE",
              "pricing_level": "PRICING_LEVEL",
              "rental_asset_profile_session_price_hours": [
                {
                  "status": "STATUS",
                  "uuid": "PRICE_HOUR_UUID",
                  "start_time": "START_TIME",
                  "end_time": "END_TIME",
                  "price": "HOURLY_PRICE"
                }
              ]
            }
          ],
          "rental_asset_profile_session_availability": [
            {
              "status": "STATUS",
              "uuid": "AVAILABILITY_UUID",
              "start_time": "START_TIME",
              "end_time": "END_TIME",
              "available": "BOOLEAN",
              "preferred_day": "DAY_OF_WEEK"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "records": "TOTAL_RECORDS",
    "limit": "LIMIT",
    "offset": "OFFSET",
    "previous_page": "PREVIOUS_PAGE",
    "next_page": "NEXT_PAGE"
  }
}

                    

Attribute	Type	Description
rental_asset_profiles	Array	List of rental asset profile objects
rental_asset_profiles.status	String	Current status of the rental asset profile
rental_asset_profiles.uuid	UUID	Unique identifier of the rental asset profile
rental_asset_profiles.name	String	Internal name of the rental asset profile
rental_asset_profiles.display_name	String	Display name shown to users
rental_asset_profiles.max_booking_limit	Integer	Maximum number of allowed bookings
rental_asset_profiles.tax_inclusive	Boolean	Indicates whether pricing includes tax
rental_asset_profiles.currency	String	Currency code used for pricing
rental_asset_profiles.tax	Object	Tax configuration associated with the profile
rental_asset_profiles.rental_assets	Array	Rental assets linked to the profile
rental_asset_profiles.rental_asset_profile_sessions	Array	Session definitions for the profile
pagination	Object	Pagination metadata for the response
pagination.records	Integer	Total number of records available
pagination.limit	Integer	Maximum records per page
pagination.offset	Integer	Offset used for pagination
pagination.previous_page	String	Link or reference to the previous page
pagination.next_page	String	Link or reference to the next page

Retrieve Rental Asset Profiles: /rental-asset-profiles