VRPlatformVRPlatform
Listings

/listings/{id}/children

List the child listings of a listing group parent.

Required scope: listings:read

GET
/listings/{id}/children

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

limit?integer
Default100
Range1 <= value <= 250
page?integer
Range1 <= value <= 9007199254740991
offset?integer
Range0 <= value <= 9007199254740991

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/listings/497f6eca-6276-4993-bfeb-53cbbbba6f08/children"
{
  "data": [
    {
      "name": "string",
      "uniqueRef": "string",
      "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
      "defaultCurrency": "string",
      "address": {
        "full": "string",
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "stateCode": "string",
        "countryCode": "string"
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "shortRef": "string",
      "title": "string",
      "pmsName": "string",
      "status": "active",
      "activeOwnership": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "startAt": "string",
        "endAt": "string",
        "reserve": -9007199254740991,
        "members": [
          {
            "split": 100000,
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "contact": {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "firstName": "string",
              "uniqueRef": "string",
              "shortRef": "string",
              "email": "user@example.com",
              "type": "owner"
            }
          }
        ],
        "setListingInactive": true,
        "businessModel": "managed",
        "lock": {
          "status": "locked",
          "booksClosed": {
            "date": "string"
          },
          "ownerStatement": {
            "ids": [
              "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ]
          },
          "reconciled": {
            "bankRecordIds": [
              "497f6eca-6276-4993-bfeb-53cbbbba6f08"
            ]
          },
          "statementPeriod": {
            "hits": [
              {
                "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
                "txnAt": "string",
                "openFrom": "string"
              }
            ]
          }
        }
      },
      "activeRecurringFeePeriods": [
        {
          "startAt": "string",
          "endAt": "string",
          "rate": -9007199254740991,
          "matchBy": "stayDate",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "recurringFee": {
            "id": "string",
            "name": "string",
            "type": "managementFee",
            "rateType": "flat",
            "defaultRate": -9007199254740991,
            "status": "active"
          }
        }
      ],
      "source": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "string",
        "status": "active",
        "appId": "string",
        "appIcon": "string"
      },
      "parent": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "uniqueRef": "string",
        "shortRef": "string"
      },
      "children": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "uniqueRef": "string",
          "shortRef": "string"
        }
      ],
      "childCount": 9007199254740991,
      "upcomingDeactivation": {
        "status": "active",
        "period": {
          "id": "string",
          "startAt": "string",
          "endAt": "string"
        }
      },
      "issues": [
        {
          "code": "missingOwnershipOrDeactivation",
          "severity": "warning",
          "context": {}
        }
      ]
    }
  ],
  "pagination": {
    "limit": 100,
    "page": 1,
    "total": 0,
    "totalPage": 0,
    "nextPage": 0
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "LOCKED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "reason": "accountClassificationLocked",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "code": "duplicateLast4",
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/listings/{id} DELETE

Previous Page

/listings/{id}/opening-balance GET

Next Page