---
title: "Get all services."
method: GET
path: "/rateplan/v0-nsfw/services"
tags: ["Service"]
---

# Get all services.

`GET /rateplan/v0-nsfw/services`

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

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

## Query parameters

- `propertyId` string
- `textSearch` string
- `onlySoldAsExtras` boolean
- `channelCodes` string[]
- `serviceTypes` string[]
- `pageNumber` integer
- `pageSize` integer
- `expand` string[]

## Response `200`

Success.

- ServiceListModel
  - `services` ServiceItemModel[], required: List of packages
    - `id` string, required: Id
    - `name` string, required: Name
    - `code` string, required: The code for the service
    - `description` string, required: Description
    - `defaultGrossPrice` MonetaryValueModel, required
      - `amount` number, double, required
      - `currency` string, required
    - `pricingUnit` 'Room' | 'Person': Defines per which unit (flat, room, person) this item is offered and priced
    - `postNextDay` boolean, required: Whether the service is delivered and posted on the same business date as the accommodation, or on the next day.
    - `serviceType` 'Other' | 'Accommodation' | 'FoodAndBeverages', nullable: The service type, used by accounting to determine the correct revenue account - <b>DEPRECATED: ServiceType is deprecated, use AccountingConfig instead</b>
    - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', nullable: The vat type, used by accounting to determine the correct vat amount and account - <b>DEPRECATED: VatType is deprecated, use AccountingConfig instead</b>
    - `availability` AvailabilityModel, required
      - `mode` 'Arrival' | 'Departure' | 'Daily', required: You can choose if the service will only be offered for the arrival or departure time slice like early check-in or a final cleaning service. You can also define a service that is available to be booked for the whole stay. The property defaults to 'Daily'.
      - `quantity` integer, nullable: Quota/Limit for service. By default service is unlimited.
      - `daysOfWeek` string[], nullable: You can choose if the service should be available for specific days of the week
    - `property` EmbeddedPropertyModel, required
      - `id` string, required: The property id
      - `code` string, nullable: The code for the property that can be shown in reports and table views
      - `name` string, nullable: The name for the property
      - `description` string, nullable: The description for the property
    - `subAccountId` string, nullable: ID of the custom sub-account, used by accounting to determine the correct revenue account - <b>DEPRECATED: SubAccountId is deprecated, use AccountingConfig instead</b>
    - `accountingConfig` ServiceItemAccountingConfigModel
      - `revenueAllocation` RevenueAllocationModel[], nullable: Revenue allocation for the service
        - `vatType` 'Null' | 'VeryReduced' | 'Reduced' | 'Normal' | 'Without' | 'Special' | 'Special1' | 'Special2' | 'ReducedCovid19' | 'NormalCovid19' | 'Mixed', required: The VAT type
        - `subAccountId` string, nullable: The custom sub-account ID
        - `percent` integer, required: The percentage of revenue allocated to the VAT type
      - `serviceType` 'Other' | 'Accommodation' | 'FoodAndBeverages': The service type
      - `validFrom` string, date: Which date this configuration is valid from
    - `channelCodes` string[], nullable: The channel codes the service is sold through
    - `ageCategoryId` string, nullable: The id of the age category associated with this service.
  - `count` integer, required: Total count of items

## Other responses

- `204`: No services could be 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-rate-plan-api-not-safe-for-work.md) - [All operations](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work/llms.txt) - [OpenAPI document](https://skmtc.dev/apaleo/apis/apaleo-rate-plan-api-not-safe-for-work/revisions/97dec9512a17?raw)