APIv1 Documentation

Authentication

A user is authenticated with the API by providing their API key. The API Key can be provided by the following 2 methods:

Using Header (recommended)

The header Authorization: Bearer-Token [TOKEN] may be set in order to authenticate a user.

Using GET-parameter

For easier discovery in the Browser and for environments, where a Authorization header cannot be used (e.g. When the page is already using the header for Basic-Auth) a request may be performed by using the parameter `&api_token=[TOKEN]`

Language

The default language of the system is german. This means that if no parameter is specified german records will be returned and german language labels.

Valid languages are the following:

Record Language

The record language can be changed by providing the &language=[LANGUAGE] GET-Parameter. This will set the language for all retrieved and saved records.

Note however, that the fallback language is german. Thus if you request detailed information about a certain entity in a language that it is not available in (say &language=foobar) then the german record will be returned.

Labels

The system is providing labels in various languages for static model properties (including select options) and dynamic field select values.

These labels can be accessed here for all supported languages:

Message Wrapper

Every API-Response (no matter if successful or not) will be wrapped in a common wrapper containing some meta-data and the complete payload.

All properties starting with an underscore contain meta information about the request.

Links

The _links property contains URLs of other API-Endpoints that might be relevant to the developer issuing the current request.

If a List view is being requested the links nextPage and previousPage will contain URLs to the next / previous page in the paginated result list.

Attributes

The _attributes relays the properties given to the endpoint (via GET-Parameter or POST-Body) back to the requester. This can be useful when debugging a request in order to ensure the server has correctly received the request.

Additionally some properties may be populated with sane defaults or additional meta data (such as _attributes.pagination).

Errors

The _errors attribute contains information about errors that occurred during execution. Most (but not all) errors result in no payload being present.

Every error contains the following properties:

Warnings

The _warnings attribute contains warnings about the current request. These warnings are meant as hints to the developer, not for user facing output.

Payload

The payload property contains the data returned by the endpoint or null if the endpoint does not return any data. 


{
    "_links": {
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1",
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.links": "GET api/v1/article/{article}/links",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files",
        "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
        "previousPage": null,
        "nextPage": "http://toubiz.local/api/v1/article?api_token=admin_token&invisible=0&private=0&pagination[page]=2"
    },
    "_warning": [
        "No page number given. Assuming first page. You can set a page by using the pagination[page] parameter.",
        "No page size given. Assuming default page size of 10. Use the parameter pagination[pageSize] to supply a custom page size."
    ],
    "_attributes": {
        "pagination": {
            "pageSize": 10,
            "page": 1,
            "total": 294,
            "lastPage": 30
        }
    },
    "_errors": [],
    "payload": [ ... ]
}

1.17.0

Added

1.16.0

Added

Changed

1.15.0

Fixed

Added

1.14.0

Added

Deprecated

1.13.1

Changed

1.13.0

Added

Changed

1.12.0

Added

Changed

1.11.4

Added

1.11.2

Added

Deprecated

1.11.1

Added

1.11.0

Changed

1.10.5

Removed

1.10.4

Changed

1.10.2

Added

Changed

Removed

1.10.1

Changes

Changes since 1.1.0 to 1.10.0

This time we provide a list of changes since 2020-07-01.

The following request and response parameters are the main changes between these releases. Minor changes are not listed and should not be breaking. Please refer to the current API documentation for a more detailed description.

2020-W27

2020-W25

2019-W50

2019-W49

2019-W46

2019-W44

2019-W43

2019-W42

2019-W40

2019-W39

2019-W37

Endpoints

docs.json

GET api/v1

Home view: Lists all endpoints with their documentation as JSON.

Examples

`$ curl -X GET http://localhost:8000/api/v1?api_token=TOKEN`

docs.html

GET api/v1/docs

Docs view: Lists all endpoints with their documentation as HTML.

article.additionalAddress

GET api/v1/article/{article}/additionalAddress

Fetches the additional address that are associated with an article.

Response

(array) Array of addresses containing the following properties

Array Items
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.

article.contactInformation

GET api/v1/article/{article}/contactInformation

Displays the contact information for the article.

Response

contactPersonTitle

(string|null) Title of the contact person.
contactPersonFirstName

(string|null) First name of the contact person.
contactPersonLastName

(string|null) Last name of the contact person.
website

(string|null) URL of the website.
twitter

(string|null) URL of a Twitter profile.
facebook

(string|null) URL of a Facebook page.
flickr

(string|null) URL of a Flickr profile.
youtube

(string|null) URL of a YouTube channel.
instagram

(string|null) URL of an Instagram profile.
vimeo

(string|null) URL of a Vimeo profile.
pinterest

(string|null) URL of a Pinterest profile.
xing

(string|null) URL of a Xing profile.
linkedIn

(string|null) URL of an LinkedIn profile.
wikipedia

(string|null) URL of a Wikipedia article.
blog

(string|null) URL of a blog.
crossiety

(string|null) URL of a crossiety profile.
tiktok

(string|null) URL of a tiktok profile
subject

(HasContactInformationInterface) The item that the contact information are for.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
locale

(string)

aerial3d

(string) DEPRECATED, use webMediaLinks
camera360

(string) DEPRECATED, use webMediaLinks
vimeoVideo

(string) DEPRECATED, use webMediaLinks
webcam

(string) DEPRECATED, use webMediaLinks
youtubeVideo

(string) DEPRECATED, use webMediaLinks

article.destroy

DELETE api/v1/article/{article}

Delete the specified article.

Examples

$ curl -X DELETE \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31?api_token=TOKEN'

{
  "_links": { ... },
  "_warning": [],
  "_attributes": [],
  "_errors": [],
  "payload": null
}

article.emails

GET api/v1/article/{article}/emails

Displays all emails associated to an article. It is possible to access this information with include=emails on the show route.

Response

(array) Array of email addresses containing the following properties

Array Items
name

(string) Name of the E-Mail address.
email

(string) E-Mail address itself.
primary

(bool) Whether this is the primary Address. Only one E-Mail address should be marked primary per article.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/emails?api_token=admin_token'

{
    "_links": {
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.contactInformation": "GET api/v1/article/{article}/contactInformation",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files",
        "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
        "api.v1.article.permissions": "GET api/v1/article/{article}/permissions",
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1"
    },
    "_warning": [],
    "_attributes": {
        "q": "/api/v1/article/740a127e-61ee-37c0-abc7-756fd80333f8/emails"
    },
    "_errors": [],
    "payload": [
        {
            "id": "bb5a2982-def7-31c2-901c-0e4fb19b5b2f",
            "name": "General Information",
            "email": "info@test.com",
            "primary": true
        },
        {
            "id": "a0133f7d-6634-4b94-8f74-5a41a41ff73f",
            "name": "Tour specific questions",
            "email": "tours@test.com",
            "primary": false
        },
    ]
}

article.eventsAtThisLocation

GET api/v1/article/{article}/eventsAtThisLocation

Fetches the events related to the current event host. This data is only available using include[]=eventsAtThisLocation on the article.show route.

Response

(array) Array of Events containing the following properties

Array Items
name

(string) Name of the event.
eventType

(string) Type of the event.
hasSchedule

(bool) If this event has any dates scheduled.
invisible

(bool) Whether this event has been marked as invisible. Invisible events cannot be seen by foreign clients - no matter what.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipTypicalForRegion

(bool) Tip: Typical for the region
type

(string) Type of the event. Must be one of local, regional, multiregional.
intro

(string|null) Short intro text about the event. May contain rich-text.
mergeDates

(bool) Whether to merge dates of intervals in the frontend.
canceled

(bool) Whether the event is canceled.
onDemand

(bool)

boost

(int) Boost value for result ranking.
datesCache

(array[]|null) READ-ONLY: An array of all generated dates for this event with datetime and id.
author

(string) Display name of author for this item.
copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
accessRestrictions
items
ticketRequired

(string) If a ticket is required.
apiVersion

The API version that this event was created by
highlight

(bool) Whether this event has been marked as a highlight.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
location

(array) Article set as location.

Array Items
id

(string) id of the Article set as location
name

(string) name of the Article set as location
updatedAt

The date at which the event was last updated.
createdAt

The date at which the event was created.
languages

(string[]) List of language in which the event is available. Only present if requested.
permissions

(object) Permissions of the current user on the event. Contains the following properties: read, write, delete, manage. Only present if requested.
preview

(object) Preview image of the event. This is an object that uses the MIME type of the file as a key and an absolute URL to the file as a value. Only present if requested.
category

(Category|null) Main category of the event.

Properties
id

(string) id of the category
name

(string) name of the category
client

(string) id of the client this event belongs to.
locale

(string) The current entities language identifier.
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the event.
dateIntervals

Information about the configured date intervals

Array Items

Date intervals define rules for generating dates for the associated event. Dates are automatically generated if the associated interval is saved in the database.The property configuration requires a different format depending on the type of interval that is being configured.

Daily (type = daily)

Defines a date interval on a daily basis such as "every day" or "every 3 days". The interval property defines how many days are in between each date. An interval of 1 means "every day" where as an interval of 4 means "every 4 days".

Monthly (type = monthly)

Defines a date interval on a monthly basis such as "every month" or "every 3 months". The interval property defines how many months are in between each date and the date property defines the date on which the event is every month.

MonthlyDayOfWeek (type = monthly_day_of_week)

Defines a monthly interval that repeats on a given week in the month.Examples for these intervals are "Every first monday of the month" or "Every second to last thursday and friday of the month".

This date interval type expects 2 configuration options to be defined:

  • days: Array of day indexes on which the dates should occur. These indexes start at 0 for sunday ( 1 for monday ).
  • week: Week definition: Defines which week the dates should occur in. Valid values are:
    • first
    • second
    • third
    • second_to_last
    • last Note, that depending on the context second_to_last can be the same as second or third but has a different logic attached to it.

NOTE: The interval property is ignored by this date interval type to prevent unnecessary complexity.

Weekdays (type = weekdays)

On every weekday of the week.This is basically the same as Weekly with predefined days (Monday - Friday). NOTE: In order to reduce complexity this date interval type ignores the interval property.

Weekly (type = weekly)

Defines a weekly date interval. Examples for weekly intervals are the following:.- Every sunday

  • Every second tuesday
  • Monday and friday of every second week

This date interval type requires the following configuration options to be set:

  • days: Array of day indexes defining which day of the week the date should be on. These indexes start at 0 for sunday (1 for monday).
type

(string) Type of the date interval. Can be one of daily, weekdays, weekly, monthly, monthly_day_of_week or yearly.
onDemand

(bool) If dates for this event can be requested.
interval

(int) Interval at which the dates should be defined. For simple intervals such as daily this allows to create dates that skip a number of days/weeks/months to build intervals such as "Every monday of every third week" ( interval=3 )
date

(date|null) Start of the interval. All generated dates are relative to this start date.
end

(date|null) End of the interval. No dates will be generated that are after this date.
startAt

(string|null) The time when the event starts at on every generated date. (HH:mm)
endAt

(string|null) The time when the event ends at on every generated date. (HH:mm)
displayDurationAs

(string) The duration can be displayed as a duration or an end time.
additionalInformation

(string) Additional information about the date.
configuration

(array) Configuration: Different depending on the type of interval (see above).
disabledDates

(array) Array of indexes of generated dates that should be manually disabled. This allows the user to manually de-select a single date in an interval.
bookingRequestUrl

(string|null) The link to a booking request.
bookingUrl

(string|null) The link to an external booking service.
canceled

(bool) All event dates for this interval should explicitly be marked as "canceled".
soldOut

(bool) All event dates for this interval are sold out.
generatedFromId

(string) Date intervals can be exploded into separate single-date intervals. This references the original interval.
humanReadableRepeatRule

(string) A human readable representation of the interval.
repeatRuleName

The type of the repeat rule.

Enum:
  • (string) daily
  • (string) weekdays
  • (string) weekly
  • (string) monthly
  • (string) monthly_day_of_week
  • (string) yearly
  • (string) none
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
bookingHotline

(string) Deprecated: Use point.booking.hotlineInformation instead.
bookingUrl

(string) Deprecated: Use point.booking.url instead.
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
webMediaLinks

(object) A list of web media links.

Array Items
type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
trashed

(boolean) Indicates whether the item is deleted.

article.fieldBlueprints

GET api/v1/article/{article}/fieldBlueprints

Some data is not defined directly on a model - rather in what is called a 'dynamic field' which is displayed to the user depending on the context of the article and the user. This allows us to display some fields only to some users or some, very specific field only for articles in very specific categories.

This endpoint returns the field blueprints: The definitions of which dynamic fields are available for the current article. This endpoint does not yet contain any values which have been entered into these fields: These are available using the article.fieldValues endpoint.

Response

(array) Array of dynamic field blueprints keyed by their id containing the following properties

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/fieldBlueprints?api_token=TOKEN'

{
  "_links": {},
  "_warning": [],
  "_attributes": [],
  "_errors": [],
  "payload": [
    {
      "id": "97cd7a3c-b532-4cb0-8625-20dc32ed2605",
      "name": "Gastro Details",
      "isGenerallyApplicable": true,
      "sorting": 0,
      "fieldSets": [
        {
          "id": "920fada4-4487-47bb-aec4-f41abc3ddb8b",
          "name": "Barrierefreiheit",
          "isGenerallyApplicable": true,
          "sorting": 0,
          "replicatable": false,
          "icon": null,
          "fields": [
            {
              "id": "8aab102d-9538-3994-9871-63c1c73124c4",
              "name": "Sanitärräume/WC's: Sitzhöhe des WC-Beckens",
              "type": "input",
              "sorting": 37,
              "configuration": {
                "type": "number",
                "uploadType": "",
                "placeholder": "cm"
              }
            },
            {
              "id": "e46d6a10-0864-3ed9-8cfb-99769344c331",
              "name": "Personal & Sonstiges",
              "type": "check",
              "sorting": 38,
              "configuration": {
                "type": "text",
                "options": [
                  "Gebärdensprache wird verstanden",
                  "Personal im Umgang mit gehörlosen/hörgeschädigten Personen geschult",
                  "Führungen in Begleitung eines Gebärdensprachdolmetschers",
                  "Akustische Verstärkungsanlagen (Induktionsschleife) bei Veranstaltungen, Führungen, an Kassen, Infostellen",
                  "Gedruckte Informationen in Großschrift/Blindenschrift/kontrastreich",
                  "Hörkassetten, Audioguides, sonstige akustische Medien",
                  "Infotafeln/Wegweiser in Blindenschrift/Relief/Großschrift/kontrastreich",
                  "Personal im Umgang mit blinden Menschen geschult",
                  "Spezielle Führungen für blinde/sehbehinderte Menschen",
                  "Führhunde erlaubt",
                  "Akustische Alarmsignale",
                  "Barrierefreier Nahverkehrsanschluss (Niederflurbusse, optische und akustische Anzeigen)",
                  "Dolmetscherdienste und/oder besondere optische Informationen für gehörlose Menschen bei Veranstaltungen",
                  "Dienstleistungen für Sehbehinderte",
                  "Dienstleistungen für Gehörlose und Schwerhörige",
                  "Rollstuhlverleih",
                  "Hilfen für Menschen mit Lernbehinderung"
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

article.fieldValues

GET api/v1/article/{article}/fieldValues

Contains the values of the dynamic fields associated with the current article. The payload is an object which uses the id of the blueprint as a key and an array of field values as the value.

It is possible to access this information with include=fieldValues on the article.show route.

Response

(array) Array of dynamic field values keyed by their id containing the following properties

Array Items
value

(object) The value of the field. This object may have different properties depending on the field type.

Properties
selected

(int|int[]) Index of the selected option for select and radio fields, array of selected indexes for checkbox field
text

(string) Contents of text inputs & textareas

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/fieldValues?api_token=TOKEN'

{
    "_links": { ... },
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": {
        "heightOfToilet": [{
            "value": { "text": "50" }
        }],
        "staffAndVarious": [{
            "value": { "selected": [ 0, 2, 4 ] }
        }]
    }
}

article.files

GET api/v1/article/{article}/files

Lists all files of the given article.

Response

(array) Array of files containing the following properties

Array Items
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/files?api_token=TOKEN'

{
    "_links": { ... },
    "_warning": [],
    "_attributes": [],
    "_errors": [],
    "payload": [
        {
            "id": "30d65e19-5e27-4b60-8803-0905442fc20a",
            "name": "index.pdf",
            "description": "",
            "url": "https://toubiz.local/storage/article/18d1f95ba1fdaf717edcca80d577ebb6__5baa054503436.pdf",
            "preview": {
                "image/png": "/dist/img/filetypes/pdf.png"
            }
        }
    ]
}

article.index

GET api/v1/article

Lists all articles visible to the user By default invisible and unlicensed articles are hidden and can be enabled using the invisible=1 and unlicensed=1 request parameters.

Attributes

include[]=permissions

Includes the permission details of the article if supplied
include[]=languages

Includes the language details of the article if supplied
include[]=mainImage

Includes the main image of the article if supplied
include[]=distance

Includes the distance to the requested coordinates. Requires the location filter.
include[]=awards

Includes the currently valid awards with minimal award blueprint and award set data.
include[]=externalIds

Also includes the ids from other services for this article
include[]=openingTimes

Also includes the opening times definition. Only for points.
include[]=tourStages

Also includes the stage information for tours.
include[]=capacity

Also includes the capacity information (total, current, etc.).
include[]=covidCasesPer100k

Also includes the Covid-19 cases on average over 7 days per 100.000 people.
include[]=snowReports

Also include snow reports for this item.
include[]=articleTypeAttributes

Also include article-type-specific attributes. E.g. point.
sizes

Specifies size classes to generate for the image where the key specifies the names of the size class and the value the size to generate. This can either be a single number, indicating the width of the image or a string containing width & height separated with an x. A request containing ?sizes[thumb]=64x64&sizes[small]=200&sizes[large]=1600 will generate these 3 sizes under the mainImage.sizes key.
include[]=phoneNumbers

Also include all phone numbers (phone, fax, mobile).
include[]=fieldValues

Also include all dynamic field values. To filter a sub-set of all field values, use includeFieldValues[0]=FIELD_BLUEPRINT_ID.
minimal=1

Returns an un-paginated object of id => name for all results.
withAggregates=1

Return aggregation numbers for the results.
withResults=0

(default: 1) Suppress the actual results.
getSortableProperties
applyChannelToQuery
search
filter[categoryTypes]

Filters articles to only include those that are associated to the primary category of a certain type.

This property can either contain a comma-separated string of category ids or an array of category types.

Examples

$ curl http://toubiz.local/api/v1/article?filter[categoryTypes][0]=area&filter[categoryTypes][1]=city
$ curl http://toubiz.local/api/v1/article?filter[categoryTypes]=area,city
filter[element]

Filters the articles to only include those matching the given element.

Examples

{ filter: { element: 'gastronomy' } }
filter[typeOfTour]

Filters articles to only include those that are associated to the primary category with the given id(s).

This property can either contain a comma-separated string of category ids or an array of category ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[typeOfTour]=stages_tour
filter[secondaryCategory]

Filters articles to only include those that are associated to the secondary category with the given id(s).

This property can either contain a comma-separated string of category ids or an array of category ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[secondaryCategory][0]=12&filter[secondaryCategory][1]=14
$ curl http://toubiz.local/api/v1/article?filter[secondaryCategory]=12,14
filter[location]

Allows filtering for articles by their location.

This property must always be specified as 3 sub-properties:

  • filter[location][latitude]
  • filter[location][longitude]
  • filter[location][radiusMeters].
filter[rectangleArea]

Allows filtering for articles by the rectangle.

This property must always be specified as 2 sub-properties and each sub-property is further divided into 2 sub-properties of lat,lng.

  • filter[northeast][lat]
  • filter[northeast][lng]
  • filter[southwest][lat]
  • filter[southwest][lng]

Examples

$ curl http://toubiz.local/api/v1/article
?filter[rectangleArea][0][lat]=33.483224&filter[rectangleArea][0][lng]=73.194616
&filter[rectangleArea][1][lat]=33.483582&filter[rectangleArea][1][lng]=73.202009
filter[type]

Filters articles by their type.

The following types exist:

  • tour
  • point
  • area.

Examples

$ curl http://toubiz.local/api/v1/article?filter[type]=tour,area,point
$ curl http://toubiz.local/api/v1/article?filter[type][0]=tour&filter[type][1]=area
filterItemType
filter[categoryType]

Filters articles to only includes those who have a category with the given category type. This search includes primary- and secondary categories.

The following category types exist:

  • point
  • tour
  • area
  • city.

If you want to search for the article type use filter[type].

Examples

$ curl http://toubiz.local/api/v1/article?filter[categoryType]=point
filter[inCollection]

Filter for articles that are in the given collection with the given id.

Examples

{ "filter": { "inCollection": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed" } }
filter[area]

Filter for articles that are in the areas with the given ids.

Examples

{ "filter": { "area": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed" } }
{ "filter": { "area": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed,9d6b82a7-a107-4cbb-b9ba-ca84e04eb2ed" } }
{ "filter": { "area": { "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed", "9d6b82a7-a107-4cbb-b9ba-ca84e04eb2ed" } } }
filter[city]

Filter for articles that are connected to cities with the given ids.

Examples

{ "filter": { "city": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed" } }
{ "filter": { "city": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed,9d6b82a7-a107-4cbb-b9ba-ca84e04eb2ed" } }
{ "filter": { "city": { "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed", "9d6b82a7-a107-4cbb-b9ba-ca84e04eb2ed" } } }
filter[notInCollection]

Filter for articles that are not in the given collection with the given id.

This is the opposite of filter[inCollection].

Examples

{ "filter": { "inCollection": "82a7a107-9d6b-4cbb-b9ba-ca84e04eb2ed" } }
filterExternalId

Filters articles by the externalId(s).

You can give one or multiple externalIds formatted like sourceName:sourceId. E.g.: outdoorActive:12345. This property can either contain a comma-separated string of externalIds or an array of externalIds.

Examples

$ curl http://toubiz.local/api/v1/article?filter[externalId]=sourceName:sourceId
$ curl http://toubiz.local/api/v1/article
?filter[externalId][]=sourceName:sourceId_1
&filter[externalId][]=sourceName:sourceId_2
$ curl http://toubiz.local/api/v1/article?filter[externalId]=sourceName:sourceId_1,sourceName:sourceId_2
filterAreaZipCode

Filters for areas that contain the given zip code(s).

Examples

$ curl http://toubiz.local/api/v1/article?filter[areaZipCode]=78120
filter[capacityLevel]

Filters for a maximum capacity level.

Examples

To filter for all articles with a capacity of 50 or lower:
$ curl http://toubiz.local/api/v1/article?filter[capacityLevel][level]=50
filter[tourDifficulty]

Filters for tour difficulty.

Examples

To filter for all articles with a given difficulty
$ curl http://toubiz.local/api/v1/article?filter[tourDifficulty]=2
filter[tourExperience]

Filters for tour experience with values from 0 to 5.

Examples

To filter for all articles with a given tour experience
$ curl http://toubiz.local/api/v1/article?filter[tourExperience][from]=0&filter[tourExperience][to]=5
filter[tourLandscape]

Filters for tour landscape with values from 0 to 5.

Examples

To filter for all articles with a given tour landscape
$ curl http://toubiz.local/api/v1/article?filter[tourLandscape][from]=0&filter[tourLandscape][to]=5
filter[tourFitness]

Filters for tour fitness with values from 0 to 5.

Examples

To filter for all articles with a given tour fitness value
$ curl http://toubiz.local/api/v1/article?filter[tourFitness][from]=0&filter[tourFitness][to]=5
filter[tourDuration]

Filters for tour duration.

Examples

To filter for all articles with a given duration
$ curl http://toubiz.local/api/v1/article?filter[tourDuration][from]=100&filter[tourDuration][to]=150
filter[tourDistance]

Filters for tour distance in meters.

Examples

To filter for all articles with a given distance
$ curl http://toubiz.local/api/v1/article?filter[tourDistance][from]=2&filter[tourDistance][to]=10
filter[tourElevationUp]

Filters for tour elevation up.

Examples

To filter for all articles with a given elevation (up)
$ curl http://toubiz.local/api/v1/article?filter[tourElevationUp][from]=2&filter[tourElevationUp][to]=10
filter[tourTechnique]

Filters for tour technique.

Examples

To filter for all articles with a given tour technique
$ curl http://toubiz.local/api/v1/article?filter[tourTechnique][from]=0&filter[tourTechnique][to]=5
filter[tourType]

Filters for tour type.

Examples

To filter for all articles with a given tour type
$ curl http://toubiz.local/api/v1/article?filter[tourType]=loop_tour
filter[tourHighlight]

Filters for tour highlight.

Examples

To filter for all articles with a given tour highlight
$ curl http://toubiz.local/api/v1/article?filter[tourHighlight][0]=culture
filter[eventLocationCapacity]

Filter for articles based on service event location aspect capacity.

Event location aspects are defined as numberBanquet, numberBlock, numberTheater, numberHorseShoe, numberSeminar and numberStanding.

Examples

To filter for articles with all event location aspects between 20 and 50.
$ curl
    http://toubiz.local/api/v1/article?filter[eventLocationCapacity][from]=20&filter[eventLocationCapacity][to]=50
To filter for articles with minimum numberStanding of 20.
$ curl
    http://toubiz.local/api/v1/article?filter[eventLocationCapacity][from]=200&filter[eventLocationCapacity][types][0]=numberStanding
To filter for articles with maximum numberStanding of 200.
$ curl
    http://toubiz.local/api/v1/article?filter[eventLocationCapacity][from]=200&filter[eventLocationCapacity][types][0]=numberStanding
To filter for articles with both numberBanquet and numberStanding between 20 and 200.
$ curl
    http://toubiz.local/api/v1/article?filter[eventLocationCapacity][from]=20&filter[eventLocationCapacity][to]=200&filter[eventLocationCapacity][types][0]=numberBanquet&filter[eventLocationCapacity][types][1]=numberStanding
filter[eventLocationSize]

Filter for articles based on service event location size in square meters.

Examples

To filter for articles event location size between 20 and 200 square meter.
$ curl http://toubiz.local/api/v1/article?filter[eventLocationSize][from]=20&filter[eventLocationSize][to]=200
To filter for articles with minimum event location size of 50 square meter.
$ curl http://toubiz.local/api/v1/article?filter[eventLocationSize][from]=50
To filter for articles with maximum event location size of 100 square meter.
$ curl http://toubiz.local/api/v1/article?filter[eventLocationSize][to]=100
filter[prepared]

Filter for articles based on snow report prepared aspect.

Examples

To filter for articles with snow report preparation aspect set to yes.
$ curl http://toubiz.local/api/v1/article?filter[prepared]=yes
To filter for articles with snow report preparation aspect set to no.
$ curl http://toubiz.local/api/v1/article?filter[prepared]=no
To filter for articles with undefined snow report preparation aspect.
$ curl http://toubiz.local/api/v1/article?filter[prepared]=undefined
filter[id]

Only fetches entities with the given ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[id][0]=...&filter[id][1]=...
filter[excludeId]

Only fetches entities not within the given ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[excludeId][0]=...&filter[excludeId][1]=...
filter[awards]

Filter for items that have one or more of the requested awards.

The filter value must be an array of either award blueprints or the ids of the award blueprints.
filter[awardTypes]

Filters for award types.

Examples

To filter for all articles with card award types
$ curl http://toubiz.local/api/v1/article?filter[awardTypes][0]=card
To filter for all articles with card and prize award types
$ curl http://toubiz.local/api/v1/article?filter[awardTypes][0]=card&filter[awardTypes][1]=prize
filter[accommodation]

Filter for articles based on service accommodationAspect.

Possible accommodation aspects are

  • bathrooms
  • beds
  • entrance
  • exterior
  • facilities
  • kitchen
  • laundry
  • view

Examples

$ curl http://toubiz.local/api/v1/article?filter[accommodation][bathrooms][0]=shower&filter[accommodation][bathrooms][1]=shampoo
$ curl http://toubiz.local/api/v1/article?filter[accommodation][beds]=double&filter[accommodation][kitchen]=couch,fridge
$ curl http://toubiz.local/api/v1/article?filter[accommodation][view]=lake&filter[accommodation][kitchen]=couch,fridge&filter[accommodation][beds]=double
filter[excludeCategory]

Excludes articles/events that have the categories with the given ids or a child as primary categories.

On its own this filter is not incredibly useful, but it can be used in combination with filter[category] in order to ignore certain subtrees of a larger category tree.
filter[category]

Filters articles/events to only include those that are associated to the primary category with the given id(s).

This property can either contain a comma-separated string of category ids or an array of category ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[category][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/event?filter[category][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/article?filter[category]=12,14
$ curl http://toubiz.local/api/v1/event?filter[category]=12,14
filter[categoryWithSecondary]

Filters articles/events to only include those that are associated to a category (primary or secondary) with the given id(s).

This property can either contain a comma-separated string of category ids or an array of category ids.

Examples

$ curl http://toubiz.local/api/v1/article?filter[categoryWithSecondary][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/event?filter[categoryWithSecondary][0]=12&filter[category][1]=14
$ curl http://toubiz.local/api/v1/article?filter[categoryWithSecondary]=12,14
$ curl http://toubiz.local/api/v1/event?filter[categoryWithSecondary]=12,14
filter[client]

Allows filtering the return value by the client it belongs to.

If multiple clients should be filtered for then the following formats are accepted:

  • array of ids
  • comma separated ids.

The string current can be provided in order to reference the client of the current user.
filter[clientIncludingManaged]

Allows filtering for client to only return entries that belong to the given client or any of it's managed clients. This property can either be set to the id of a client or to the string current if all entries of the current client should be returned.
filter[createdBy]

Allows filtering for the creator of an item.

This filter can be specified in one of the following formats if multiple users are filtered for:

  • Array of ids
  • Comma separated string.
filterDeleted
filter[dynamicFieldValueSelect]

Examples

$ curl http://toubiz.local/api/v1/article
?filter[dynamicFieldValueSelect][BLUEPRINT_UUID][0]=OPTION_UUID
&filter[dynamicFieldValueSelect][BLUEPRINT_UUID][1]=OTHER_OPTION_UUID
filter[lastEditedBy]

Allows filtering for the last editing user of an item.

This filter can be specified in one of the following formats if multiple users are filtered for:

  • Array of ids
  • Comma separated string.
unlicensed
invisible

Also include invisible items of the current client in the API response.

By default, only visible items will be returned - set invisible=1 in order to also list the private events that the current user has access to.
filterStrictInvisible
filter[license]

Filters articles by license.

This property can either contain a comma-separated string of licenses or just one license.

Examples

$ curl http://toubiz.local/api/v1/article?filter[license][0]=12&filter[license][1]=14
$ curl http://toubiz.local/api/v1/article?filter[license]=12,14
filter[withManualPermission]

Filters items by manual permissions.

Examples

$ curl http://toubiz.local/api/v1/article?filter[withManualPermission]=1
filter[pitchMaxLength]

Filter for articles based on service pitch aspect maxLength in meter.

Examples

To filter for articles service pitch aspect maxLength between 20 and 200 meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchMaxLength][from]=20&filter[pitchMaxLength][to]=200
To filter for articles with minimum service pitch aspect maxlength of 50 meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchMaxLength][from]=50
To filter for articles with maximum service pitch aspect maxLength of 100 meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchMaxLength][to]=100
filter[pitchSize]

Filter for articles based on service pitch aspect size in square meters.

Examples

To filter for articles service pitch aspect size between 20 and 200 square meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchSize][from]=20&filter[pitchSize][to]=200
To filter for articles with minimum service pitch aspect size of 50 square meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchSize][from]=50
To filter for articles with maximum service pitch aspect size of 100 square meter.
$ curl http://toubiz.local/api/v1/article?filter[pitchSize][to]=100
filter[vehicleType]

Filter for articles based on service pitch aspect vehicleType.

Examples

$ curl http://toubiz.local/api/v1/article?filter[vehicleType]=camper,panel_van
$ curl http://toubiz.local/api/v1/article?filter[vehicleType][0]=camper&filter[vehicleType][1]=panel_van
filter[services]

Filters articles by attached services.

This property can either be an array of service types or an array of arrays, where the key is the service type and the nested array is a list of sub-types.

Valid types with sub-types are:

  • accommodation [room, apartment, special]
  • event_location [banquet_hall, conference_room, meeting_room, exhibition_space, auditorium]
  • various [flat_rate, ticket, rental, wellness]

Examples

Return all articles with services:
$ curl http://toubiz.local/api/v1/article?filter[services][]=
Return all articles with accommodation services:
$ curl http://toubiz.local/api/v1/article?filter[services][]=accommodation
Return all articles with accommodation services that are rooms:
$ curl http://toubiz.local/api/v1/article?filter[services][accommodation][]=room
filterSourceSystemInformation
filterSourceSystem
filter[tag]

Filters for one or more tags that must be present on the article.

If multiple tags are given, then results are guaranteed to have at least one of the tags but not necessarily all of them.

Examples

# Multiple tags
$ curl https://mein.toubiz.de/api/v1/[...]?filter[tag][]=foo&filter[tag][]=bar
# Multiple tags comma-separated
$ curl https://mein.toubiz.de/api/v1/[...]?filter[tag]=foo,bar
# Single tag
$ curl https://mein.toubiz.de/api/v1/[...]?filter[tag]=foo
filter[excludeTag]

Only fetches entities not with the given tags.

Examples

# Multiple tags
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag][]=foo&filter[excludeTag][]=bar
# Multiple tags comma-separated
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag]=foo,bar
# Single tag
$ curl https://mein.toubiz.de/api/v1/[...]?filter[excludeTag]=foo
filter[highlight]

Filter for articles that are marked as highlights.

This property can be set to true or 1 in order to only return highlights. If set to false or 0 then all articles (including highlights & non-highlights) are returned.
filterTip
filter[deletedAfter]

Retrieves only trashed data from the parent table at a specified date.
filter[updatedAfter]

Only returns items that have been updated after the given date & time.

This property can be used together with filter[updatedBefore] in order to only select items that have been edited in a given timespan.

Examples

curl http://toubiz.local/api/v1/event?filter[updatedAfter]=2018-08-01
curl http://toubiz.local/api/v1/event?filter[updatedAfter]=2018-08-01T00:12:00
filter[updatedBefore]

Only returns items that have been updated before the given date & time.

This property can be used together with filter[updatedAfter] in order to only select items that have been edited in a given timespan.

Examples

curl http://toubiz.local/api/v1/[article|event]?filter[updatedBefore]=2018-08-01
curl http://toubiz.local/api/v1/[article|event]?filter[updatedBefore]=2018-08-01T00:12:00
filter[createdAt]

Filter article or events based on created at.

Examples

curl http://toubiz.local/api/v1/article?filter[createdAt][after]=2018-08-01
curl http://toubiz.local/api/v1/article?filter[createdAt][before]=2018-08-01
curl http://toubiz.local/api/v1/event?filter[createdAt][after]=2018-08-01&filter[createdAt][before]=2018-09-01

Response

(array) Array of Articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
name

(string) Name of the category.
nameWithParents

(string) Name of the category including all of it's parents. The names of parents and children are separated by the character ».
rootline

(array) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

address

(object) The address of the point (only if type=point)

Properties
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
client

(object) The assigned client

Properties
crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
name

(string) Name of the client.
url

(string) URL of the clients Website.
plan

(string) Which license model the customer has with us.
email

(string)

phoneNumber

(string)

title

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
factor

(float) How much the customer pays for the license.
id

(string|null) The primary UUID
logo

(object) Logo of the client.

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.

Examples

$ curl -g -X GET \
    http://toubiz.local/api/v1/article?api_token=TOKEN&pagination[pageSize]=5&filter[primaryCategory]=20ab716a-406c-3bcf-a133-b54b5dcc1e72

{
    "_links": {
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.contactInformation": "GET api/v1/article/{article}/contactInformation",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files",
        "api.v1.article.additionalAddress": "GET api/v1/article/{article}/additionalAddress",
        "api.v1.article.permissions": "GET api/v1/article/{article}/permissions",
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1",
        "previousPage": null,
        "nextPage": "http://toubiz.ddev.site/api/v1/article?q=%2Fapi%2Fv1%2Farticle&api_token=%242y%2410%24uWEpfM.YINolDOvThZf6NOGWd0vnp6%2F8Aj9cArpqBf8iE19nGxuTG&pagination[pageSize]=3&filter[category]=20ab716a-406c-3bcf-a133-b54b5dcc1e72&invisible=0&private=0&pagination[page]=2"
    },
    "_warning": [
        "No page number given. Assuming first page. You can set a page by using the pagination[page] parameter.",
        "No page number given. Assuming first page. You can set a page by using the pagination[page] parameter."
    ],
    "_attributes": {
        "q": "/api/v1/article",
        "pagination": {
            "pageSize": 3,
            "page": 1,
            "total": 19,
            "lastPage": 7
        },
        "filter": {
            "category": "20ab716a-406c-3bcf-a133-b54b5dcc1e72"
        }
    },
    "_errors": [],
    "payload": [
        {
            "id": "c86ef64e-6667-3899-ad17-6e9c5f49abe2",
            "name": "Haus Pluto",
            "abstract": "",
            "description": "<p>Das ist ein Test. Wird mein Name in der Revision angezeigt? Auch wenn der User gel\u00f6scht wird?\u00a0</p>\n<p><strong>Das ist ein Test. Wird mein Name in der Revision angezeigt? Auch wenn der User gel\u00f6scht wird?\u00a0</strong></p>\n<p>Das ist ein Test. Wird mein Name in der Revision angezeigt? Auch wenn der User gel\u00f6scht wird?\u00a0</p>",
            "generalInformation": "",
            "type": "point",
            "primaryCategory": {
                "id": "18192c0a-c88d-36e3-8778-bdc5d91bc7f1",
                "name": "Pension",
                "nameWithParents": "\u00dcbernachten \u00bb Gasth\u00f6fe und Pensionen \u00bb Pension",
                "type": "point",
                "invisible": false
            },
            "private": false,
            "invisible": false,
            "updatedAt": "2018-11-05T10:46:06",
            "tipHighlight": false,
            "address": {
                "id": "62858f76-55f6-372c-8c8e-b9744e3eadb3",
                "name": "",
                "nameWithParents": "",
                "type": "",
                "invisible": false
            }
        },
        {
            "id": "c33c065f-9322-382a-acd4-abcdf11f3956",
            "name": "Das Haus f\u00fcr Naturfreunde",
            "abstract": "",
            "description": "",
            "generalInformation": "",
            "type": "point",
            "primaryCategory": {
                "id": "1a041b7b-9dcf-395c-9e06-ffa8f64c0942",
                "name": "Naturfreundehaus",
                "nameWithParents": "\u00dcbernachten \u00bb Sammelunterk\u00fcnfte  \u00bb Naturfreundehaus",
                "type": "point",
                "invisible": false
            },
            "private": false,
            "invisible": false,
            "updatedAt": "2018-09-19T14:36:30",
            "tipHighlight": false,
            "address": {
                "id": "73188077-978c-3cf1-9038-6cc4f6e0d310",
                "name": "LIS 6",
                "nameWithParents": "",
                "type": "",
                "invisible": false
            }
        },
        {
            "id": "98bf6eb8-e7d0-3ed7-a9b9-b15305ad8e57",
            "name": "Merkmals Typ Test",
            "abstract": "",
            "description": "",
            "generalInformation": "",
            "type": "point",
            "primaryCategory": {
                "id": "1d27e9c6-63bc-3e7c-9068-5db51df44808",
                "name": "Ferienhaus",
                "nameWithParents": "\u00dcbernachten \u00bb Ferienwohnungen/-h\u00e4user \u00bb Ferienhaus",
                "type": "point",
                "invisible": false
            },
            "private": false,
            "invisible": false,
            "updatedAt": "2018-10-23T08:22:32",
            "tipHighlight": false,
            "address": {
                "id": "bbd44950-113d-3b21-a518-343b66d5f88f",
                "name": "Merkmals Typ Test",
                "nameWithParents": "",
                "type": "",
                "invisible": false
            }
        }
    ]
}

article.media

GET api/v1/article/{article}/media

Lists all media of the given article. It is possible to access this information with include=media on the show route.

Attributes

sizes

Specifies size classes to generate for the image where the key specifies the names of the size class and the value the size to generate. This can either be a single number, indicating the width of the image or a string containing width & height separated with an x. A request containing ?sizes[thumb]=64x64&sizes[small]=200&sizes[large]=1600 will generate these 3 sizes under the sizes key.

Response

(array) Array of media objects containing the following properties

Array Items
name

(string) Name of the media element.
description

(string) General description of the image.
altText

(string) Alt-Text that describes the content of the image for non-sighted users or in case loading of the image fails.
agreedUsageRightsAt

(date|null) The timestamp the usage rights where guaranteed.
agreedUsageRightsBy

(User|null) The user who guaranteed the usage rights.
checksum

(string) The checksum of the underlying file.
tags

(array<MediaTag>) Tags can be added to media for special treatment. This can be a a different displaying, no displaying, etc.
author

(string) Display name of author for this item.
copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
preview

(object) Deprecated, please use sizes. Contains the first size class from sizes for backwards compatibility.
main

(bool) If the media element is fetched from a relation (e.g. Article images) that support the selection of a main image then this property contains that main image state.
client

(integer) ID of the client this media element is associated to.
clientName

(string) Name of the client this media element is associated to.
createdAt

(string) DateTime of this media creation.
updatedAt

(string) Last DateTime of this media update.
uploadedBy

(string) Name of the user who uploaded this media.
fileType

(string) Human readable version of the MIME Type fo the media element.
url

(string) Url to the Image on the server.
colors

(object) Average colors at different positions in the image.

Properties
topleft

(string) Average hex-color of the top-left corner
topright

(string) Average hex-color of the top-right corner
bottomleft

(string) Average hex-color of the bottom-left corner
bottomright

(string) Average hex-color of the bottom-right corner
center

(string) Average hex-color of the center
focusPoint

(object) The focus point which is used to center the image.

Properties
x

(int) The X component of the focus point which is used to center the image.
y

(int) The Y component of the focus point which is used to center the image.
dimensions

(object) Dimensions of the full image Contains width and height properties

Examples

$ curl -X GET \
    'http://toubiz.local/api/v1/article/94cba5bd-4413-4546-9d25-d9b4e338ce31/media?api_token=admin_token&preview=320x240

{
    "_links": {
        "documentation.html": "GET /api/v1/docs",
        "documentation.json": "GET /api/v1",
        "api.v1.article.index": "GET api/v1/article",
        "api.v1.article.update": "PUT api/v1/article/{article}",
        "api.v1.article.store": "POST api/v1/article",
        "api.v1.article.destroy": "DELETE api/v1/article/{article}",
        "api.v1.article.show": "GET api/v1/article/{article}",
        "api.v1.article.media": "GET api/v1/article/{article}/media",
        "api.v1.article.tags": "GET api/v1/article/{article}/tags",
        "api.v1.article.emails": "GET api/v1/article/{article}/emails",
        "api.v1.article.fieldValues": "GET api/v1/article/{article}/fieldValues",
        "api.v1.article.fieldBlueprints": "GET api/v1/article/{article}/fieldBlueprints",
        "api.v1.article.seo": "GET api/v1/article/{article}/seo",
        "api.v1.article.openingTimes": "GET api/v1/article/{article}/openingTimes",
        "api.v1.article.phoneNumbers": "GET api/v1/article/{article}/phoneNumbers",
        "api.v1.article.files": "GET api/v1/article/{article}/files"
    },
    "_warning": [],
    "_attributes": {
        "preview": "320x240"
    },
    "_errors": [],
    "payload": [
        {
            "id": "30d65e19-5e27-4b60-8803-0905442fc20a",
            "name": "Jenkins 300x300",
            "copyright": "",
            "altText": "",
            "caption": "",
            "preview": {
                "image/png": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/320x240q75.png",
                "image/jpeg": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/320x240q75.jpg",
                "image/webp": "http://toubiz.local/storage/cache/file/public/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png/320x240q75.webp"
            },
            "url": "http://toubiz.local/storage/2905/373916000c77fa98f55d09fad09c4063__5ba9fc90e54b5.png",
            "hasCustomCaption": false,
            "description": "",
            "main": false,
            "client": 1,
            "fileType": "PNG"
        }
    ]
}

article.nearbyArticles

GET api/v1/article/{article}/nearbyArticles

Response

areas

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
name

(string) Name of the category.
nameWithParents

(string) Name of the category including all of it's parents. The names of parents and children are separated by the character ».
rootline

(array) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

address

(object) The address of the point (only if type=point)

Properties
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
client

(object) The assigned client

Properties
crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
name

(string) Name of the client.
url

(string) URL of the clients Website.
plan

(string) Which license model the customer has with us.
email

(string)

phoneNumber

(string)

title

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
factor

(float) How much the customer pays for the license.
id

(string|null) The primary UUID
logo

(object) Logo of the client.

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
areaAccommodations

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
name

(string) Name of the category.
nameWithParents

(string) Name of the category including all of it's parents. The names of parents and children are separated by the character ».
rootline

(array) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

address

(object) The address of the point (only if type=point)

Properties
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
client

(object) The assigned client

Properties
crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
name

(string) Name of the client.
url

(string) URL of the clients Website.
plan

(string) Which license model the customer has with us.
email

(string)

phoneNumber

(string)

title

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
factor

(float) How much the customer pays for the license.
id

(string|null) The primary UUID
logo

(object) Logo of the client.

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
areaHighlights

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
name

(string) Name of the category.
nameWithParents

(string) Name of the category including all of it's parents. The names of parents and children are separated by the character ».
rootline

(array) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

address

(object) The address of the point (only if type=point)

Properties
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
client

(object) The assigned client

Properties
crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
name

(string) Name of the client.
url

(string) URL of the clients Website.
plan

(string) Which license model the customer has with us.
email

(string)

phoneNumber

(string)

title

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
factor

(float) How much the customer pays for the license.
id

(string|null) The primary UUID
logo

(object) Logo of the client.

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
areaParking

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
name

(string) Name of the category.
nameWithParents

(string) Name of the category including all of it's parents. The names of parents and children are separated by the character ».
rootline

(array) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

address

(object) The address of the point (only if type=point)

Properties
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
client

(object) The assigned client

Properties
crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
name

(string) Name of the client.
url

(string) URL of the clients Website.
plan

(string) Which license model the customer has with us.
email

(string)

phoneNumber

(string)

title

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
factor

(float) How much the customer pays for the license.
id

(string|null) The primary UUID
logo

(object) Logo of the client.

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
areaPublicTransport

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
name

(string) Name of the category.
nameWithParents

(string) Name of the category including all of it's parents. The names of parents and children are separated by the character ».
rootline

(array) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsSpecific

(array) Array of the specific field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupsHighlight

(array) Array of the highlight field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

fieldGroupTypesWithParents

(array) Array of all field groups that belong to the category including inherited

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags

(array) Tags can be added to flag blueprints for special treatment. This can be a a different displaying, no displaying, etc.
hidden

(array<int,string>)

awardSets

(array) Array of award sets connected to this field set

Array Items
title

(string)

icon

(string)

allowMultiple

(bool)

awardBlueprints

(array<AwardBlueprint>)

dynamicFieldSets

(array<DynamicFieldSet>)

showInList

(bool)

type

(string)

id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

address

(object) The address of the point (only if type=point)

Properties
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
client

(object) The assigned client

Properties
crmLink

(string) Link to our CRM (Freshsales) with more information about the customer.
customerAbbreviation

(string) Customer abbreviation only used for internal communication.
name

(string) Name of the client.
url

(string) URL of the clients Website.
plan

(string) Which license model the customer has with us.
email

(string)

phoneNumber

(string)

title

(string)

linkToToubizUsageDetail

(string) Link to a detail page with information about the customer’s use of my.toubiz.
factor

(float) How much the customer pays for the license.
id

(string|null) The primary UUID
logo

(object) Logo of the client.

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
contactPerson

(object) Contact person of the client.

Properties
type

(string) Type of the user. Can have one of the following values: editor, manager, admin.
username

(string) Unique username that identifier the user.
firstName

(string) First name of the user .
lastName

(string) Last name of the user.
company

(string) Company the user works for.
email

(string) E-Mail address of the user. Should be unique in the system.
tosAcceptedAt

(date|null) Time at which the user has accepted the terms of service.
lastLoginAt

(date|null) Time of the users last login.
displayName

(string) Full name to display.
client

(object) Name and ID of the client to which the user belongs

Properties
id

(string) ID of the client
name

(string) Name of the client
externalIds

(array) The id of this article for a number of external services.
geocoordinates

(array) The geocoordinates of the article.
point

(object) Point specific attributes. Only returned if the article is of the type point.

Properties
gettingThere

(string) How to get to the point.
status

(string) The open/closed status.
price
freeEntry

(bool) Whether entry is free. Setting this property to true disables the price table as a price table for a free entry does not make any sense.
priceComment

(string) Comments about the pricing. May be rich-text.
currencies

(array) An array of accepted currencies.
marketingPriceComment

(string) Comments about the marketing pricing.
marketingPrices

(array) One price per currency for the promotional purpose.

Array Items
id

string The id of the marketing price.
currency

string The currency.
price

float The price.
priceGroups

(array) Price groups and their defined fields

Array Items
comment

(string) Comment to a price group
title

(string) Title to a price group
priceEntries
Array Items
comment

(string) Comment to a price entry
title

(string) Title to a price entry
eur

(float) The price in EUR
chf

(float) The price in CHF
address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use article.point.booking.information instead.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
area

(object) Area specific attributes. Only returned if the article is of the type area.

Properties
gettingThere

(string)

claim

(string)

facts

(string)

zipCodes

(array<ZipCode>)

communalLink

(string) Link to the communal homepage.
communalLogo

(File)

address
name

(?string) Name of the address (e.g. name of the building or enterprise).
street

(?string) Street name.
streetNumber

(?string) Street number.
zip

(?string) ZIP Code of the city.
city

(?string) Name of the city.
stateCode

(?int) The integer code of the state. Follows the AGS in Germany.
state

(?string) The name of the state.
country

(string) 2-digit Country code.
highlightCollection

(object) Collection of highlight articles

Properties
name

(string) Name of the collection.
type

(string) Type of the collection. Can be one of article or event.
id

(string|null) The primary UUID
articles

(int[]) Array of article ids that belong to this collection (only for type=article)
events

(int[]) Array of event ids that belong to this collection (only for type=event)
preview

(object) Preview image for the collection. This is the first main image in the collection and is an object that uses the MIME-Type of the image as a key and the URL to the image as a value.
latitude

(string) Deprecated: Use article.latitude instead.
longitude

(string) Deprecated: Use article.longitude instead.
tour

(object) Tour specific attributes. Only returned if the article is of the type tour.

Properties
startPoint

(string) Information about the starting point of the tour. May be rich-text.
startPointLocation

(TourLocation|null) Information about the location of starting point of the tour.
endPoint

(string) Information about the end point of the tour. May be rich-text.
endPointLocation

(TourLocation|null) Information about the location of end point of the tour.
endPointToStartPoint

(string) Information about getting from the end point back to the start point.
startPointGettingThere

(string) Information about start point getting there. May be rich-text.
authorTip

(string) Tips by the author. May be rich-text.
safetyInformation

(string) Important safety information for the user. May be rich-text.
gear

(string) Gear that is recommended for this tour. May be rich-text.
moreInformation

(string) General additional information. May be rich-text.
approach

(string) Information about how to navigate around the tour. May be rich-text.
directions

(string) Directions on how to find the start point. May be rich-text.
publicTransit

(string) Information about public transit. May be rich-text.
publicTransportGettingThere

(string) Information about public transport getting there. May be rich-text.
parking

(string) Information about the parking situation. May be rich-text.
endPointParking

(string) Information about tour end point parking situation. May be rich-text.
literature

(string) Additional literature about the tour.
trustedMaps

(string) List of trusted / recommended maps. May be rich-text.
protectedAreas

(string) Information about protected areas in and around the tour. May be rich-text.
typeOfTour

(string) The type of tour (loop tour, one way tour, etc).
trackType

(string) The type of track (foot, bike, car).
difficulty

(int|null) 0-2 difficulty rating of the tour.
fitness

(int) 0-5 fitness rating of the tour.
technique

(int) 0-5 technique rating of the tour.
experience

(int) 0-5 experience rating of the tour.
landscape

(int) 0-5 landscape rating of the tour.
scenic

(bool) Scenic
geology

(bool) Geological highlights
flora

(bool) Botanical highlights
culture

(bool) Cultural highlights
fauna

(bool) Fauna highlights
healthyClimate

(bool) Healthy climate
refreshmentPoints

(bool) Refreshment points
sights

(bool) Sights
terrain

(array) The different sections in the terrain ('unknown', 'asphalt', 'gravelPath', 'nature', 'miscellaneous')
signPosts

(array<Media>) The different Sign Guide Posts of a Tour
status

Tour (opening-) status.

Enum:
  • (string) none
  • (string) open
  • (string) closed
geometry

(object) GeoJSON data for tour geometries. Does not apply to stage tours

Properties
points

(array) Point data for tours. Does not apply to stage tours.
recommendedTimeOfTravel

(object) Information about which months are recommended to travel in.

Properties
january

(bool) Whether january is a recommended travel time.
february

(bool) Whether february is a recommended travel time.
march

(bool) Whether march is a recommended travel time.
april

(bool) Whether april is a recommended travel time.
may

(bool) Whether may is a recommended travel time.
june

(bool) Whether june is a recommended travel time.
july

(bool) Whether july is a recommended travel time.
august

(bool) Whether august is a recommended travel time.
september

(bool) Whether september is a recommended travel time.
october

(bool) Whether october is a recommended travel time.
november

(bool) Whether november is a recommended travel time.
december

(bool) Whether december is a recommended travel time.
trackInformation

(array) Array of all GPS Track information.

Array Items
duration

(int) Estimated duration of the tour in minutes
distance

(int) Distance the tour spans in meters
elevationUp

(float) Meters of elevation upwards.
elevationDown

(float) Meters of elevation downwards.
highestPoint

(float) Highest point of the tour.
lowestPoint

(float) Lowest point of the tour.
premiumTourEditHash

(string|null) Hash that can be used to restore the tour path in the toursprung editor. See also: MTK.RoutePlanner#loadFromHash.
trackType

(string) Type of the track

Enum:
  • (string) bike
  • (string) foot
  • (string) car
premiumTourEditType

(string|null) Type of the editing view

Enum:
  • (NULL)
  • (string) car
  • (string) foot
  • (string) bike
file

(object|null) GPX / KML Track file associated with this track

Properties
name

(string) Name of the file.
description

(string) Description of the file. This may be rich-text.
path

(string) Path to the file in the storage.
url

(string) Relative URL to the file.
size

(int) Size of the file in bytes.
license

License of the file.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
preview

(object) DEPRECATED, use sizes instead. Preview of the file. This is an object that uses the MIME type as key and the preview url corresponding to that MIME Type as value.
sizes

(object) Scaled preview images according to the size classes given in the request. The 2-dimensional object uses the name of the size class as a key of the first dimension, the mime-type of the scaled images as a key of the second dimensions and the URL of the scaled image as a value.
relationType

(string) The type of relation for this file.
tourStageCollections

(array) Array of all tour stage collections.

Array Items
name

(string)

sorting

(int)

stages

(array<Article>) The tour stages (tour articles with typeOfTour "stage".
trackDownload

(array) Array of all track downloads in various formats.

Array Items
url

(string) The public download url.
type

(string) The file type (gpx, kml, etc.).
reference

(array) Information about the track being referenced. Could be a single tour or a tour stage collection.

Properties
id

(string) The id of the object.
type

(string) The model type being referenced.
booking
hotline

(?string) The phone number of the hotline.
hotlineInformation

(?string) Additional information about the hotline.
information

(?string) Information about the booking provider.
requestUrl

(?string) The request url.
url

(?string) The booking url.
voucherUrl

(?string) Where to buy a voucher.
advanceBookingTime

(?int) How long in advance the ticket must be booked.
additionalBookingInformation

(string) Deprecated: Use point.booking.information instead.
capacity

(object) Information about the capacity (total, current, etc.)

Properties
totalCapacity

(int) The total capacity as an absolute number.
currentLevel

(int) The current level of visitors.
currentLevelType

(int) If the current level is an absolute number or a percentage.
currentLevelUpdatedAt

(date) When the current level was last updated.
currentLevelPercentage

(int|null) The normalized current level. Is calculated internally.
prediction

(array) The predicted visitors over the course of a week in 3hr steps, starting at 3am and ending at midnight.
predictionFor

(string) The default scenario the prediction is for (bad weather, etc.)
predictionNotice

(array) Additional information, e.g. about how the weather affects the prediction values.
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
pivot

(stdClass|null)

casts

(array<string,string|object>)

hidden

(array<int,string>)

fillable

(array<int,string>)

attributes

(array<string,string>)

webMediaLinks

(object) A list of web media links.

Array Items
type

(string) The type of the web link
url

(string) The URL itself pointing ot an external media object
title

(string|null) An optional title for displaying the link
description

(string|null) An optional description for this link
sorting

(int) If multiple links exist for the same type, this sorting is used (the highest first)
id

(string|null) The primary UUID
createdAt

(date|null) The timestamp this item was created at
updatedAt

(date|null) The timestamp this item was last modified at
sourceSystemInformation
documentation

(array) A list of source systems this items data is coming from.
trashed

(boolean) Indicates whether the item is deleted.
discoveries

(array) Array of articles containing the following properties

Array Items
name

(string) The name of the article.
abstract

(string) Abstract / Short description(rich text)
description

(string) Description (rich text)
type

(string) Type of the article.

Enum:
  • (string) point
  • (string) tour
  • (string) area
invisible

(bool) The invisible/visible state. Similarly to the public/private state an article is only visible to its own client if it is set to be invisible.
tipFamous

(bool) Tip: Famous
tipHighlight

(bool) Whether this event has been marked as a highlight.
tipIdyllic

(bool) Tip: Idyllic
tipNatural

(bool) Tip: Close to nature & quiet:
tipOffTheTrack

(bool) Tip: Off the track
tipOnlyHere

(bool) Tip: Only exists here
tipPopular

(bool) Tip: Gladly visited
tipTypicalForRegion

(bool) Tip: Typical for the region
currentInformation

(string) Current information about this article.
apiVersion

(int)

author

(string) Display name of author for this item.
longitude

(?float)

latitude

(?float)

copyright

(string|null) The holder of the copyright.
sourceInformationLink

(string|null) Link to information about the source of the item.
license

(string|null) License of the item or NULL if no license set.

Enum:
  • (string) none
  • (string) community
  • (string) cc-zero
  • (string) cc-by
  • (string) cc-sa
  • (string) cc-by-sa
  • (string) cc-by-nc
  • (string) cc-by-nc-sa
  • (string) cc-by-nd
  • (string) cc-by-nc-nd
highlight

(bool) Whether this event has been marked as a highlight.
locale

(string) The current language of the category
createdAt

The date at which the article was created.
updatedAt

The date at which the article was last updated.
primaryCategory

(object) The primary category.

Properties
name

(string) Name of the category.
nameWithParents

(string) Name of the category including all of it's parents. The names of parents and children are separated by the character ».
rootline

(array) All category ids from the root up to this category
rootlineNames

(array) All category names from the root up to this category
invisible

(bool) Whether the category is currently invisible.
type

Type of the category.

Enum:
  • (string) root
  • (string) point
  • (string) event
  • (string) tour
  • (string) event_host
  • (string) area
  • (string) city
fieldGroupsGeneral

(array) Array of the general field groups that belong to the category directly (without inheritance)

Array Items
name

(string) Name of the group.
sorting

(int) Sorting of this group among other groups. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the group is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this group.
icon

(string)

description

(string) The user facing description.
showInMenu

(bool) If the group should be listed as a sub-route of the detail-information-section.
tags

(array) Tags can be added to flag field groups for special treatment. This can be a a different displaying, no displaying, etc.
fieldSets

(array) Array of field sets belonging to this group.

Array Items
name

(string) Name of the field set.
replicatable

(bool) Whether this field can contain multiple values. If a field is marked as replicable then the user can simply add new values by replicating the field over and over again.
replicationHeadlineToken

(string|null) Token to build a numbered headline for replication instances.
sorting

(int) Sorting of this set among other sets in the same group. Lower numbers will appear first, higher numbers later.
isGenerallyApplicable

(bool) Whether the set is generally applicable. If it is generally applicable then it will be displayed to all clients. If not, then each client has to be whitelisted in order to see this set.
customFaq

(bool) With this setting, the field set will always offer an FAQ item with custom question (and answer).
fields

(array) Array of fields belonging to this set.

Array Items <
name

(string) Name of the field.
description

(string|null) An editor-facing description.
icon

(string) Icon for the particular field.
type

(string) Type of the field. This can be one of the following: input, textarea, select, check, radio, upload, help_text.
sorting

(int) The sorting index of this field among other fields in it's set.
configuration

(stdClass) Configuration of the field. This may differ from field to field.
tags