Reports and Forms

Report and digital form endpoints are dashboard-derived. Payload and response fields can vary by enabled tenant features and form schemas.

GET /scheduled-report

GET

List scheduled reports

/scheduled-reportlinxio.reports.scheduled(params)

Returns a paginated list of scheduled reports.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

number

optional

Number of records per page.

number

optional

Page number to read.

LinxioFileFormat

optional

Optional format filter when accepted by Linxio.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

ISODateString

optional

Optional date range filters when accepted by Linxio.

Response body fields

LinxioScheduledReport[]

optional

Scheduled reports for the current page.

Show child parameters

LinxioFileFormat

optional

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

LinxioId

required

Scheduled report identifier.

string

optional

Scheduled report display name.

active | disabled | string

optional

Scheduled report status.

string

optional

Scheduled report type.

number

optional

Pagination metadata.

Request

curl "https://api.linxio.com/api/scheduled-report?limit=50&page=1" \
  -H "Authorization: Bearer $LINXIO_TOKEN"

Example response


{
  "data": [
    {
      "format": "json",
      "id": 64553,
      "name": "Example",
      "status": "online",
      "type": "Truck"
    }
  ],
  "page": 1,
  "limit": 100,
  "total": 2
}

GET /scheduled-report/template

GET

Get scheduled report template

/scheduled-report/templatelinxio.reports.scheduledTemplate()

Returns scheduled-report template metadata used by the dashboard.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

void

optional

No query parameters are required.

Response

LinxioRecord

optional

Template metadata. Shape can vary by tenant.

GET `/scheduled-report/{reportId}`

GET

Get a scheduled report

/scheduled-report/{reportId}linxio.reports.getScheduled(reportId)

Returns one scheduled report by ID.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Scheduled report identifier.

Response body fields

LinxioId

optional

Scheduled report identifier.

string

optional

Report display name when supplied.

string

optional

Report type when supplied.

LinxioFileFormat

optional

Output format when supplied.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

POST /scheduled-report

POST

Create a scheduled report

/scheduled-reportlinxio.reports.createScheduled(payload)

Creates a scheduled report.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request body parameters

string

required

Report display name.

string

required

Report type accepted by Linxio.

LinxioFileFormat

required

Output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

Record<string, unknown>

optional

Report-specific parameters such as schedule, recipients, date range, filters, or vehicle IDs.

Response body fields

LinxioId

optional

Created scheduled report ID.

Request

curl -X POST https://api.linxio.com/api/scheduled-report \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Weekly Fleet Summary",
    "type": "fleet-summary",
    "format": "pdf",
    "params": {
      "timezone": "Australia/Perth"
    }
  }'

Example response


{
  "id": 64553
}

PATCH `/scheduled-report/{reportId}`

PATCH

Update a scheduled report

/scheduled-report/{reportId}linxio.reports.updateScheduled(reportId, payload)

Updates a scheduled report.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Path and body parameters

LinxioId

required

Scheduled report identifier.

Partial<LinxioScheduledReportPayload>

required

Fields to update.

Show child parameters

LinxioFileFormat

required

Report output format.

Possible enum values

csv

Comma-separated values export.

pdf

PDF export.

xlsx

Excel workbook export.

string

required

Scheduled report display name.

Record<string, unknown>

optional

Report-specific parameter object.

string

required

Scheduled report type.

Response body fields

LinxioId

optional

Updated scheduled report ID.

Request

curl -X PATCH https://api.linxio.com/api/scheduled-report/123 \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
    "name": "Updated Weekly Fleet Summary"
  }'

Example response


{
  "id": 64553
}

DELETE `/scheduled-report/{reportId}`

DELETE

Delete a scheduled report

/scheduled-report/{reportId}linxio.reports.deleteScheduled(reportId)

Deletes a scheduled report.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Scheduled report identifier.

Response headers

204 or JSON

optional

Successful delete response.

PATCH `/scheduled-report/{reportId}/restore`

PATCH

Restore a scheduled report

/scheduled-report/{reportId}/restorelinxio.reports.restoreScheduled(reportId)

Restores a scheduled report when the dashboard-derived endpoint is available.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

application/json

required

Required when sending a JSON request body.

Request url parameters

LinxioId

required

Scheduled report identifier.

Response headers

204 or JSON

optional

Successful restore response.

Request

curl -X PATCH https://api.linxio.com/api/scheduled-report/123/restore \
  -H "Authorization: Bearer $LINXIO_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{}'

Example response


{
  "status": "online"
}

GET /digital-form/form

GET

List digital forms

/digital-form/formlinxio.digitalForms.list()

Lists digital forms visible to the authenticated account.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request query parameters

void

optional

No query parameters are required.

Response body fields

LinxioId

optional

Digital form identifier.

string

optional

Digital form display name when supplied.

string

optional

Form status when supplied.

GET `/digital-form/form/{formId}`

GET

Get a digital form

/digital-form/form/{formId}linxio.digitalForms.get(formId)

Returns one digital form by ID.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Digital form identifier.

Response body fields

LinxioId

optional

Digital form identifier.

string

optional

Digital form display name when supplied.

GET `/digital-form/answer/{answerId}`

GET

Get a form answer

/digital-form/answer/{answerId}linxio.digitalForms.answer(answerId)

Returns one digital form answer. Shape depends on the form schema.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Digital form answer identifier.

Response

LinxioRecord

optional

Answer payload. Shape varies by form schema.

GET `/digital-form/answer/{answerId}/pdf`

GET

Download a form answer PDF

/digital-form/answer/{answerId}/pdflinxio.digitalForms.answerPdf(answerId)

Downloads a digital form answer as a PDF.

Request headers

Bearer token

required

JWT bearer token returned by login or token refresh.

Request url parameters

LinxioId

required

Digital form answer identifier.

Response

application/pdf

optional

PDF binary body.

Reports and Forms

List scheduled reports

Request headers

Request query parameters

Response body fields

Get scheduled report template

Request headers

Request query parameters

Response

Get a scheduled report

Request headers

Request url parameters

Response body fields

Create a scheduled report

Request headers

Request body parameters

Response body fields

Update a scheduled report

Request headers

Path and body parameters

Response body fields

Delete a scheduled report

Request headers

Request url parameters

Response headers

Restore a scheduled report

Request headers

Request url parameters

Response headers

List digital forms

Request headers

Request query parameters

Response body fields

Get a digital form

Request headers

Request url parameters

Response body fields

Get a form answer

Request headers

Request url parameters

Response

Download a form answer PDF

Request headers

Request url parameters

Response

On this page