---
title: "Returns a list of authorizations based on the query parameters"
method: GET
path: "/booking/v0-nsfw/authorizations"
tags: ["Authorization"]
---

# Returns a list of authorizations based on the query parameters

`GET /booking/v0-nsfw/authorizations`

## 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/booking/v0-nsfw/authorizations`
- Auth: OAuth 2
  - Implicit: `https://identity.apaleo.com/connect/authorize`
  - Scopes: `authorizations.read`, `authorizations.manage`, `admin`

<br>You must have at least one of these scopes: 'authorizations.read, authorizations.manage'.<br>For fine-grained clients, you must have this permission: 'core.authorizations.read'.

## Query parameters

- `propertyIds` string[]
- `bookingIds` string[]
- `reservationIds` string[]
- `status` string[]
- `targetTypes` string[]
- `dateField` 'Creation' | 'Modification' | 'Expiration'
- `from` string, date-time
- `to` string, date-time
- `pageNumber` integer
- `pageSize` integer
- `sort` string[]
- `expand` string[]

## Response `200`

Successfully returned authorization list

- AuthorizationListModel
  - `authorizations` AuthorizationModel[], required: List of authorizations
    - `id` string, required: Authorization id
    - `target` AuthorizationTargetModel, required
      - `type` 'Booking' | 'Reservation', required: Authorization target type
      - `id` string, required: Booking or reservation id
      - `propertyId` string, required: The id of the property the authorization is to be created for. When target is Reservation, the property must be the same the reservation.
    - `created` string, date-time, required: Date of creation<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
    - `updated` string, date-time, required: Date of last modification<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
    - `externalReference` ExternalAuthorizationReferenceModel
      - `paymentTransactionId` string, required: Identifies the payment authorization in the Payment Transaction API
    - `amount` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
    - `remainingBalance` MonetaryValueModel
      - `amount` number, double, required
      - `currency` string, required
    - `status` 'Pending' | 'Success' | 'Failure' | 'Canceled' | 'Expired' | 'RefreshPending', required: Status of the authorization
    - `failureReason` string, nullable: Human-readable failure reason
    - `payerInteraction` 'Terminal' | 'PaymentAccount' | 'Authorization' | 'PaymentLink', required: Payer interaction of the authorization
    - `expiresAt` string, date-time, nullable: The date and time the authorization expires<br />A date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>
    - `paymentLinkUrl` string, nullable: The URL to the payment link when authorization is created by payment link
    - `actions` ActionModelAuthorizationActionNotAllowedAuthorizationActionReason[], nullable: The list of actions for authorization
      - `action` 'Cancel' | 'Refresh' | 'ExpirePaymentLink', required
      - `isAllowed` boolean, required
      - `reasons` ActionReasonModelNotAllowedAuthorizationActionReason[], nullable
        - `code` 'OnlySuccessfulAuthorizationCanBeCanceled' | 'OnlySuccessfulAuthorizationCanBeRefreshed' | 'NonActiveAuthorizationCanNotBeRefreshed' | 'OnlyPendingPaymentLinkAuthorizationCanBeExpired', required
        - `message` string, required
  - `count` integer, required: Total count of items

## Other responses

- `204`: No authorizations found.
- `400`: Bad request.
- `401`: You are unauthorized.
- `403`: Forbidden.
- `404`: The Request-URI could not be found.
- `422`: Validation errors in the request body or query params.
- `499`: Client closed request.
- `500`: An unexpected error occurred.
- `503`: The server is currently unavailable. Please try later.

---

[API](https://skmtc.dev/apaleo/apis/apaleo-booking-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-booking-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-booking-api-not-safe-for-work/revisions/a1b6a2f6b879?raw)