Get a recurring series

Returns the recurrence rule for a shift series by its id.

GET

/v1/shifts/series/{seriesId}

Authorizations

• oauth2
  shifts:read

Responses

200

A recurring series rule

Media typeapplication/json

object

item

required

object

id

required

integer

>= -9007199254740991 <= 9007199254740991

userId

required

integer

>= -9007199254740991 <= 9007199254740991

freq

required

string

Allowed values: daily weekly monthly

interval

required

integer

>= -9007199254740991 <= 9007199254740991

byWeekday

Array

until

string

count

integer

>= -9007199254740991 <= 9007199254740991

anchorDate

required

string

Example

{
  "item": {
    "id": 0,
    "userId": 0,
    "freq": "daily",
    "interval": 0,
    "byWeekday": [
      0
    ],
    "until": "string",
    "count": 0,
    "anchorDate": "string"
  }
}