When a tip is posted to the acting user's inbox

GET

/api/v1/hints/schedule

const url = 'http://localhost:11044/api/v1/hints/schedule';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/hints/schedule \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

cron is the six-field expression the schedule runs on, in the user’s own zone; null when tips are off.

Authorizations

apiKeyAuth
basicAuth

Responses

200

The schedule in force

*/*

The acting user’s tip schedule and the cron expression it runs on; answered by GET and PUT /hints/schedule

object

cron

Spring six-field cron expression the schedule runs on (second minute hour day month day-of-week), read in the user’s own time zone; null when frequency is NEVER

string

frequency

required

How often a tip is posted to the inbox; NEVER means tips are off

string

Allowed values: NEVER DAILY WEEKDAYS WEEKLY

hour

required

Hour of day (0-23) the tip is posted, in the user’s own time zone

integer format: int32

401

Not authenticated