Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Charged entrances

Get all entrances

Get a list of entrances in the CareCloud platform.

get/entrances

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

pos_id3 | 6 | 9 | 11

ID of POS system for tickets. Required with path parameter entrance ID. Possible values are: EPOS - 3 / skidata - 6 / axess - 9 / base - 11

external_order_idstring

ID of an external order created in POS system.

namestring

Name of the charged entrance (product name is used from resource products).

resort_namestring

Name of the resort where is an entrance charged.

customer_category_namestring

Name of the customer category.

card_idstring

ID of a card used for charging entrance. GET /cards

customer_idstring

The unique ID of the customer. GET /customers

entrance_type_id0 | 1 | 2

Type of the entrance. Possible values are: season ticket - 0/ one day ticket -1/ multiple day ticket - 2

state0 | 1

State of the entrance. Possible values are: canceled entrance - 0 / valid entrance -1

external_entrance_idstring

External ID of the entrance. Structure can be different depends of POS system, that created entrance.

is_validtrue | false

in validity range - true / before or after validity range - false / no value - all

is_cancelledtrue | false

Filter for canceled entrances. Possible values: true - all cancelled entrances / false - all non cancelled entrances / no value - all entrances

valid_fromstring

Start of the validity period for filtering in ISO-8601 format (YYYY-MM-DD).

valid_tostring

End of the validity period for filtering in ISO-8601 format (YYYY-MM-DD).

product_idstring

The unique ID of the product. GET /products

external_turnstile_permission_idstring

External ID of the turnstile permission. Structure can be different depends of the POS system, that created the permission.

order_item_idstring

ID of an item from e-shop order.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "entrances": [
      {
        "entrance_id": "80a7be2e78aabc1454ca817265",
        "name": "1 Dňový Skipas - Akcia 7.1. - 22.1.2015",
        "external_order_id": "d03df0e0-959a-11e4-a6ce-0050569b002b",
        "external_entrance_id": "1-1760-61-107788",
        "external_turnstile_permission_id": "1-1760-61-107788",
        "entrance_type_id": 1,
        "order_item_id": "84947e1aa1ad6982cc8188d15c",
        "card_id": "8c9fd120242ef646f477a5ed80",
        "created_at": "2015-01-06 12:54:46",
        "cancelled_at": "2015-01-09 22:38:48.088",
        "charge_date": "2015-01-10 00:00:00",
        "last_change": "2019-08-29 13:04:45",
        "state": 1
      }
    ],
    "total_items": 1
  }
}