Skip to main content
GET
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Query Parameters

limit
integer<int64>
default:100

Limit the number of resources returned by the API

Required range: x >= 1
offset
integer<int64>
default:0

Offset the resources returned by the API

Required range: x >= 0
sort
enum<string>[]

A comma separated list of fields to sort by.

Available options:
created_at,
-created_at
filter
string
default:""

Filters the response data based on the value provided.

Available filters:

  • eq(id,xxx): Filter device backups by ID.
  • eq(organisation,xxx): Filter by the organisation a backup is filed against.
  • eq(author,xxx): Filter to the backups one user sent, by user ID. This is how a member's backups are read.
  • eq(reference,xxx): Find the backup an operative read out, e.g. eq(reference,K7QM-3X9P).
  • ge(created_at,xxx) / le(created_at,xxx): Filter by when a backup was sent. Use the function-style ge/le operators (not gte/lte).

For more information on using named filters, see the docs

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
organisation,
author

Response

List of device backups.

JSON API response object

data
A list of device backups · object[]
required
meta
object
required
jsonapi
object
required
included
object[]

Related resources that can be included when a device backup is returned.

An organisation