Get studio general information

Deprecated

Required Scopes: `STUDIO_READ` Returns studio's general information for authenticated subject

Endpoint

GET /v1/studios/information

Responses

OK

Response Body application/json

General studio information visible for user

name

Studio name

Example:  "Example studio"
description

Studio description

Example:  "Example studio description"
country

Studio address' country

Example:  "Germany"
countryCode string(ISO 3166-1)

Studio address' country code

Example:  "DE"
studioId integer(int64) required

Studio Id

Example:  123
openingDate string(date)

Studio opening date

Example:  "2025-06-11"
closingDate string(date)

Studio closing date

Example:  "2029-01-01"
email

Studio email address

Example:  "operator@example.com"
logoUrl

Url to studio logo

Example:  "https://example.com"
telephone

Studio telephone

Example:  "0831/6901234-10"
website

Studio website url

Example:  "https://example.com"
openingHours array[object]

Studio internal opening hours

dayOfWeekFrom

Start day of given range opening hours

Allowed values:
MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
dayOfWeekTo

End day of given range opening hours

Allowed values:
MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
timeFrom string(time)

Start hour of the range opening hours in ISO-8601 format

Example:  "06:00:00"
timeTo string(time)

End hour of the range opening hours in ISO-8601 format

Example:  "23:00:00"
publicOpeningHours array[object]

Studio public opening hours

dayOfWeekFrom

Start day of given range opening hours

Allowed values:
MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
dayOfWeekTo

End day of given range opening hours

Allowed values:
MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
timeFrom string(time)

Start hour of the range opening hours in ISO-8601 format

Example:  "06:00:00"
timeTo string(time)

End hour of the range opening hours in ISO-8601 format

Example:  "23:00:00"
closingHours array[object]

Studio closing hours

reason

Reason of closure

Example:  "Public holiday"
dateTimeFrom string(date-time)

Start of the range closing hours

Example:  "2025-09-21T00:00:00"
dateTimeTo string(date-time)

End of the range closing hours

Example:  "2025-09-22T00:00:00"
openingHoursCategories array[object]

Studio opening hours categories with time restrictions

categoryId integer(int64) required

ID of the opening hours category

Example:  1234567890
name required

Name of the opening hours category

Example:  "Off-Peak"
openingHours array[object] required

List of opening hours for this category

dayOfWeek required

Day of the week

Allowed values:
MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY
Example:  "MONDAY"
timeFrom string(time) required

Start time in ISO-8601 format

Example:  "06:00:00"
timeTo string(time) required

End time in ISO-8601 format

Example:  "23:00:00"
street

Studio address' street

Example:  "Kastanienallee"
houseNumber

Studio address' house number

Example:  "83"
zip

Studio address' zip code

Example:  "84439"
city

Studio address' city

Example:  "Berlin"
accessCodeConfiguration required

Studio access code configurations

enabled

Whether or not the access code is enabled

location

Location of a Studio

longitude number(double)

The longitude of the coordination of the location

Example:  9.993682
latitude number(double)

The latitude of the coordination of the location

Example:  53.551086
studioTags array[object]

Tags associated with the studio

name required

Unique name of a tag

Example:  "tag123"
Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"