Get employees

Deprecated

Required Scopes: `EMPLOYEE_READ` Returns employees for studio defined by used x-api-key.

Endpoint

GET /v1/employees

Query Parameters

offset string

Offset from last request

Default:  0

sliceSize integer (int32)

Desired size of data chunk

Default:  50

Responses

OK

Response Body application/json

result array[object] required

List of employees

id integer(int64) required

Unique ID of the employee

Example:  1001
firstName required

The first name of the employee

Example:  "Peter"
lastName required

The last name of the employee

Example:  "Parker"
employeeImageUrl

The URL of the employee image

Example:  "https://example.com/image.jpg"
gender required

Gender of the customer

Allowed values:
MALE Male gender of the customer
FEMALE Female gender of the customer
UNISEX Unisex gender of the customer
Example:  "MALE"
dateOfBirth string(date)

The date of birth of the employee

Example:  "1990-01-01"
employeeNumber

The employee number

Example:  "123456a"
employeeInitials required

The initials of the employee

Example:  "P.P."
publicName

The public name of the employee

Example:  "Peter Parker"
businessRole

The business role of an employee

Allowed values:
STUDIO_OWNER The employee is the owner of the studio.
STUDIO_MANAGER The employee is the manager of the studio.
TRAINER The employee is a trainer of the studio.
SERVICE_EMPLOYEE The employee is a service employee of the studio.
ADMINISTRATION_OR_FINANCE The employee is participating in administration or finance of the studio.
MARKETING The employee is participating in marketing of the studio.
Example:  "STUDIO_OWNER"
externalRole

The external role of the employee

Example:  "Trainer"
phone1

The first phone number of the employee

Example:  "+49123456789"
phone2

The second phone number of the employee

Example:  "+49123456789"
email

The email of the employee

Example:  "example@example.com"
street

The street of the employee

Example:  "Main Street"
houseNumber

The house number of the employee

Example:  "123a"
zipCode

The zip code of the employee

Example:  "123-45"
city

The city of the employee

Example:  "Berlin"
country

The country of the employee

Example:  "DE"
employeeCompetences array[object]

The competences of the employee

Example:  ["Trainer"]
hasNext required

True if there exists next data slice

Example:  true
offset required

Offset for next query

Example:  "1234567890"
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"