APapaleo
CapturePolicies

Get all capture policies.

Get the list of capture policies.<br>You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.

get/settings/v1/capture-policies

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/settings/v1/capture-policies
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: settings.read, setup.read, setup.manage, admin

Query parameters

propertyIdstring

Filter capture policies by the specified property

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

Response

Success.

countinteger required

Total count of items

Example response

{
  "capturePolicies": [
    {
      "id": "MUC-CAP",
      "code": "CAP",
      "captureNoShowFee": false,
      "captureCancellationFee": false,
      "capturePrepayment": true,
      "postOtaBankTransferOnCheckOut": false,
      "capturePayment": "CheckOut",
      "propertyId": "MUC"
    }
  ],
  "count": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.