Vacation TrackerDeveloper Docs
REST API v2API referenceScheduled reports

Get a scheduled report

This API method returns a single scheduled report. Requires notifications:read.

Errors: 403 SCHEDULED_REPORTS_NOT_AVAILABLE (the company is not on the Complete plan), 403 FORBIDDEN (the key owner is neither an admin nor a location admin), and 404 RESOURCE_NOT_FOUND (the report does not exist, or the key owner is a location admin and the report has no locations or includes a location they do not manage).

GET
/v2/scheduled-reports/{id}

Authorization

bearerAuth notifications:read
AuthorizationBearer <token>

API key sent as Authorization: Bearer vt_live_<secret>. See the Authentication and Scopes sections at the top of this document for how keys are created, which scopes exist and how the key owner's role limits them.

In: header

Scope: notifications:read

Path Parameters

id*string

resource ID.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/scheduled-reports/string"
{
  "data": {
    "id": "scheduledReport-8a47c61e-2b7f-4d5e-9c61-3f1c2b9e1d93",
    "name": "Monthly balances",
    "reportType": "leaveBalanceReport",
    "period": "LAST_MONTH",
    "locationIds": [],
    "departmentIds": [],
    "labelIds": [],
    "receivers": [
      "hr@chaochao.com"
    ],
    "timezone": "Europe/Belgrade",
    "sendDayOfMonth": 1,
    "sendHourUtc": 7,
    "sendMinuteUtc": 30,
    "creatorId": "user-63b17e97-d38b-4586-8498-bb4f5d2e2c14"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "name": "Unauthorized",
    "description": "The API key is missing, malformed or not recognized.",
    "resolution": "Send a valid API key in the Authorization header as Bearer followed by the full vt_live_ key.",
    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_SCOPE",
    "name": "InsufficientScope",
    "description": "The API key does not have the scopes this request needs.",
    "resolution": "Add the scopes listed in details.requiredScopes to the key in the Vacation Tracker dashboard.",
    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef",
    "details": {
      "requiredScopes": [
        "leaves:write"
      ]
    }
  }
}

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "name": "ResourceNotFound",
    "description": "The requested resource does not exist or is outside the data this key can access.",
    "resolution": "Check the ID of the resource named in details.resource and that the key owner can see it.",
    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "name": "RateLimited",
    "description": "Too many requests were sent in a short time.",
    "resolution": "Wait a few seconds and retry, using the same Idempotency-Key for writes.",
    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "name": "InternalError",
    "description": "Something went wrong on our side.",
    "resolution": "Retry later, and if it keeps happening, contact Vacation Tracker support and quote the requestId.",
    "requestId": "c6af9ac6-7b61-11e6-9a41-93e8deadbeef"
  }
}

Need help?

developers@vacationtracker.io

Create a scheduled report

This API method creates a report that is emailed to receivers every month. Requires notifications:write. The acting user is the key owner, or the X-On-Behalf-Of user, and becomes the report's creator (creatorId). It must be an admin, or a location admin who manages every location in locationIds; a location admin must send at least one location. It waits for the report to be created and returns it with 201, or 202 Accepted with an operation to poll.

Update a scheduled report

This API method changes a scheduled report. Requires notifications:write. The acting user is the key owner, or the X-On-Behalf-Of user. It waits for the change and returns the report with 200, or 202 Accepted with an operation to poll.