Query

Object

cloudServices

Get all Cloud Services

cloudService

Get a specific Cloud Service

cloudEndpoints

Get all Cloud Endpoints, optionally filtering by a given Cloud Service

cloudEndpoint

Get a specific Cloud Endpoint

integrations

Get all Integrations

integration

Get an Integration by ID

integrationVersion

Get a specific Integration Version

integrationVersions

Get all versions of an Integration

installedIntegrations

Installed Integrations

recurringTasks

Get the list of recurring tasks for an Organization, optionally filtered by Device and/or Integration

recurringTask

Get a single recurring task

actionLog

Get an action log by ID

actionLogs

Get a list of action logs

apiKeys

Get all API Keys

apiKey

Get a single API Key by its ID

networks

The list of Networks available

network

A specific Network

networkMembers

Visible other Member nodes of the Network, depending on the NetworkMode

networkNodes

The Networks that this Platform is part of

networkNode

A Specific NetworkNode

networkReceivedJobs

The list of jobs this Platform has received

networkReceivedJob

A specific NetworkReceivedJob

networkSentJobs

The list of jobs this Platform has sent

networkSentJob

A specific NetworkSentJob

knowledgeBase

Return the current KnowledgeBase used for AI operations

estimates

Return a paginated list of estimates, sortable and filterable using the provided query and order parameters.

estimate

Return a single estimate by its ID.

me

cloudCredentials

List all of the CloudCredentials.

cloudCredential

Return a specific CloudCredential by ID.

configValue

Get a single config value by its ID or name.

configValues

List all the config values

invitations

List all the invitations

invitation

Get a single invitation by its ID.

invitationByToken

Get an invitation by its token - this route is unauthenticated for new user signups, but heavily rate limtied to prevent abuse

notifiers

Returns a list of all notifiers.

notifier

Returns a specific notifier by ID.

platform

The current Platform

org

The current Organization

users

List all the users

user

Get a single user by their ID.

customer

This query returns a single customer

customers

This query returns a list of customers

order

This query returns a single order

orders

This query returns a list of orders

controller

Return a single Controller

controllers

Return a list of Controllers

device

Return a single Device

jmfDeviceQueue

The current state of a JMF Device Queue

devices

Return a list of Devices

deviceVendors

Return the available list of Device Vendors

deviceStatus

Return the latest DeviceStatus

deviceStatuses

Return a list of DeviceStatuses

hotFolder

Return a single Hotfolder

hotFolders

Return a list of Hotfolders

carriers

Get a list of Carriers

carrier

Get a single Carrier by ID

containers

Get a list of Containers

container

Get a single Container by ID

locations

Get a list of locations

location

Get a single location by ID

shippingServices

Get a list of Shipping Services

shippingService

Get a single Shipping Service by ID

shipments

Get a list of Shipments

shipment

Get a single Shipment by ID

transfers

Get a list of transfers

transfer

Get a single transfer by ID

processNets

List all ProcessNets, optionally filtering by active status or Job

processNet

Get a single ProcessNet by ID

activeJobProcessNet

Get the active process net for a Job

job

jobs

part

parts

milestone

milestones

operation

operations

workQueue

workQueues

workQueuePlacement

workQueuePlacements

reaction

Get a Reaction by ID.

reactions

Get all Reactions for an Organization.

reactionTriggers

Get all supported Reaction triggers.

drives

Return all the drives for an Organization

drive

Return a single drive by ID.

files

Return paginated files within a Drive

file

Return a single file by ID.

metrics

Get a list of metrics

metric

Get a metric by name

metricPoints

Get a list of metric points

scriptLibraries

Get a list of script libraries

scriptLibrary

Get a script library by ID

scripts

Get a list of scripts

script

Get a script by ID

emailFolders

Fetches a list of email folders.

emailFolder

Fetches a single email folder by its unique identifier.

emails

Fetches a list of emails based on the provided filter.