CLcloudbeds
Schedules

Get schedules

get/datainsights/v1.1/schedules

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or API key in header X-API-KEY

Query parameters

offsetinteger

The difference between start of the data and the start of the response data

limitinteger
Example:5

The maximum number of results in the response

idinteger

Filter by Schedule ID

subjectstring

Subject of the email

frequencystring

Schedule frequency in cron format.

Needs to match the following pattern:

(0)\                                                                        # minutes ~ 0
(\*|([0-9]|1[0-9]|2[0-3])|\*)\                                              # hours ~ * OR 0-23
(\*|([1-9]|[1-2][0-9]?|3[0-1]))?(,(\*|([1-9]|[1-2][0-9]?|3[0-1]))){0,30}\   # day of month ~ * OR 1-31
(\*|([1-9]|1[0-2]?))?(,(\*|([1-9]|1[0-2]?))){0,12}\                         # month ~ * OR 1-12
(\*|[0-6])(,(\*|[0-6])){0,7}                                                # day of week ~ * OR 0-6
$                                                                           # matches the end of the string
  • 0 10 * * 0,1,2,4,5 - At 10:00 on Sunday, Monday, Tuesday, Thursday, and Friday
  • 0 10 * * 2 - At 10:00 on Tuesday
  • 0 23 * 12 * - At 23:00 in December
  • 0 23 1,31 1,2,5,6,7,10,11 1,3 - At 08:00 on day-of-month 1 and 31 and on Monday and Wednesday in January, February, May, June, July, October, and November
matchstring

Match schedule frequency based on date (2022-01-02T18:00:00Z)

sort'subject,asc' | 'subject,desc' | 'view,asc' | 'view,desc' | 'format,asc' | 'format,desc' | 'created_at,asc' | 'created_at,desc' | 'updated_at,asc' | 'updated_at,desc' | 'id,asc' | 'id,desc'

Sort schedules

Headers

X-PROPERTY-IDinteger

Property id of the client

Response

OK

offsetinteger

The difference between start of the data and the start of the response data

limitinteger

The maximum number of results in the response

totalinteger

The total number of records

Example response

{
  "limit": 5,
  "total": 42,
  "schedules": [
    {
      "id": 1,
      "frequency": "0 10 15 * *",
      "view": "formatted",
      "format": "xlsx",
      "created_at": "2022-01-01T12:00:00Z",
      "updated_at": "2022-01-02T10:00:00Z",
      "upcoming_at": "2022-01-02T18:00:00Z",
      "property_id": 1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.