TypeScript SDK
client.appInstances
Reference for the AppInstancesResource — list connected E-BON mobile-app instances, mirroring /api/v1/app-instances.
client.appInstances
client.appInstances wraps /api/v1/app-instances/* — the registry of connected E-BON mobile-app instances that can claim physical devices via client.devices.claim. See the matching REST documentation at App instances API.
Minimal surface — see the App instances API reference for the full endpoint, including admin-only paths that the SDK does not yet expose.
HTTP-level failures surface as EBonApiError — see Errors and the Errors API reference.
client.appInstances.list(query?)
List connected app instances.
async list(query?: ListAppInstancesQuery): Promise<ListAppInstancesResult>
| Name | Type | Required | Notes |
|---|---|---|---|
locationId | string | no | Filter to instances at a single location. |
Returns { instances: AppInstance[] }.
const { instances } = await client.appInstances.list({ locationId: 'loc_01HZ...' });