GUguesty
Accounting (only available for accounting add-on users)

Get Business Models

Changed on

Get list of Business Models by accountId, pass includeAssignedListings=true to include per-model assignedListings

get/business-models-api/light-business-models

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/business-models-api/light-business-models
  • Auth
    API key in header authorization

Query parameters

skipnumber
Example:5

Skip number of records. In case nothing provided so nothing will be skipped

limitnumber
Example:10

Limit for list of records. In case nothing provided all the records will be returned

includeAssignedListingsboolean
Example:true

When true, each business model includes assignedListings info (listingId, assignmentType, assignedAt, activationDate). Default false

Response

Latest versions of business models response

skipnumber required
limitnumber required
countnumber required

Example response

{
  "list": [
    {
      "category": "Enterprise",
      "assignedListings": [
        {
          "listingId": "5f1c2a3b4c5d6e7f8a9b0c01",
          "assignmentType": "current",
          "assignedAt": "2025-11-02T10:14:33.000Z",
          "activationDate": "2025-11-01T00:00:00.000Z"
        }
      ],
      "assignedListingsTruncated": true
    }
  ]
}

Changes

  • 3122b8618183Revision changes
    • info

      added the new optional query request parameter includeAssignedListings

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status