List All Devices

Access a list of provisioned SynLink devices. Must include API key. Returns devices that are associated with the user linked to the API key. Device and outlet names use the effective CMP name, including pending or failed desired names. Name metadata includes lastKnownName, queuedName (null after synchronization), and nameSyncStatus (pending, synced, or failed). Reading pending names does not change the GET response status; existing offline live-read responses remain HTTP 503 with last-known data. Each device includes customfield1. Search returns all matching references, including duplicates.

Query Params
int32
Defaults to 1

Page number (1-based)

int32
Defaults to 20

Results per page (max recommended = 100)

Case-insensitive substring match on device name, model number, enclosure serial number, or customfield1.

string

"connected" or "disconnected" to filter by current connection status.

string

"devicename" or "enclosureserialnumber". If omitted, results are ordered Connected → Disconnected.

string
Defaults to asc

"asc" or "desc". Ignored when sortBy is not provided.

int32

Return only devices that are members of the specified group ID.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json