Get user's out of office state

GET

/domains/{domainID}/users/{userID}/oof

curl --request GET \
  --url https://example.com/api/v1/domains/1/users/1/oof \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

userID

required

integer

ID of the user

Responses

200

Out-of-office state returned

Media typeapplication/json

object

state

Out-of-office state (0=Disabled, 1=Enabled, 2=Scheduled)

integer

Allowed values: 0 1 2

externalAudience

External audience setting (0=None, 1=Known, 2=All)

integer

Allowed values: 0 1 2

startTime

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

endTime

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

internalSubject

Subject for internal out-of-office reply

string

default: Out of Office nullable

internalReply

Internal out-of-office reply body

string

nullable

externalSubject

Subject for external out-of-office reply

string

default: Out of Office nullable

externalReply

External out-of-office reply body

string

nullable

Example

{
  "state": 0,
  "externalAudience": 0,
  "internalSubject": "Out of Office",
  "externalSubject": "Out of Office"
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

One of the required external services is unavailable

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}