API Documentation
Designed for Grace Cloud Connect - Fire
Call this API to retrieve all pendant / gateway / asset data within your organization. Optionally, you can use parameters to fetch logs or filter your results based on user ID / status.
Parameters
Name | Required | Type | Description |
id | false | string | To fetch a specific pendant, pass a single id (Group - UserId - e.g. 10-10 ). Excluding this parameter will default the query to fetch all pendants |
logs | false | int | When querying a single pendant, you can specify the amount of logs to return. |
filter | false | string | To filter pendants based on current / last status, pass a string of statuses seperated by a comma to filter by. If no filter is passed, all pendants will be returned. Only available when querying all pendants, filter will be ignored when a pendant id is specified. MAXIMUM of 5 statuses can be passed at a time. |
Response
Name | Type | Description |
pendants | Array | An Array of pendant document(s) that match the query |
count | int | Amount of pendant docs return from the query. |
logs | Array | Array of pendant logs (Only returned when querying a single pendants logs) |
ms | int | Timestamp in MS of when the request was sent. |