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.

Query parameters

limit

number

optional

Number of records per page.

page

number

optional

Page number to read.

format

csv | pdf | xlsx

optional

Optional format filter when accepted by Linxio.

startDate / endDate

ISODateString

optional

Optional date range filters when accepted by Linxio.

Response fields

data

LinxioScheduledReport[]

optional

Scheduled reports for the current page.

page / limit / total

number

optional

Pagination metadata.

GET /scheduled-report/template

GET

Get scheduled report template

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

Returns scheduled-report template metadata used by the dashboard.

Query parameters

none

void

optional

No query parameters are required.

Response

data

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.

Path parameters

reportId

LinxioId

required

Scheduled report identifier.

Response fields

id

LinxioId

optional

Scheduled report identifier.

name

string

optional

Report display name when supplied.

type

string

optional

Report type when supplied.

format

csv | pdf | xlsx

optional

Output format when supplied.

POST /scheduled-report

POST

Create a scheduled report

/scheduled-reportlinxio.reports.createScheduled(payload)

Creates a scheduled report.

Body parameters

name

string

required

Report display name.

type

string

required

Report type accepted by Linxio.

format

csv | pdf | xlsx

required

Output format.

params

Record<string, unknown>

optional

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

Response fields

id

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"
    }
  }'

PATCH `/scheduled-report/{reportId}`

PATCH

Update a scheduled report

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

Updates a scheduled report.

Path and body parameters

reportId

LinxioId

required

Scheduled report identifier.

body

Partial<LinxioScheduledReportPayload>

required

Fields to update.

Response fields

id

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"
  }'

DELETE `/scheduled-report/{reportId}`

DELETE

Delete a scheduled report

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

Deletes a scheduled report.

Path parameters

reportId

LinxioId

required

Scheduled report identifier.

Response

status

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.

Path parameters

reportId

LinxioId

required

Scheduled report identifier.

Response

status

204 or JSON

optional

Successful restore response.

GET /digital-form/form

GET

List digital forms

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

Lists digital forms visible to the authenticated account.

Query parameters

none

void

optional

No query parameters are required.

Response fields

id

LinxioId

optional

Digital form identifier.

name

string

optional

Digital form display name when supplied.

status

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.

Path parameters

formId

LinxioId

required

Digital form identifier.

Response fields

id

LinxioId

optional

Digital form identifier.

name

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.

Path parameters

answerId

LinxioId

required

Digital form answer identifier.

Response

data

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.

Path parameters

answerId

LinxioId

required

Digital form answer identifier.

Response

body

application/pdf

optional

PDF binary body.

Reports and Forms

List scheduled reports

Query parameters

Response fields

Get scheduled report template

Query parameters

Response

Get a scheduled report

Path parameters

Response fields

Create a scheduled report

Body parameters

Response fields

Update a scheduled report

Path and body parameters

Response fields

Delete a scheduled report

Path parameters

Response

Restore a scheduled report

Path parameters

Response

List digital forms

Query parameters

Response fields

Get a digital form

Path parameters

Response fields

Get a form answer

Path parameters

Response

Download a form answer PDF

Path parameters

Response

On this page