---
title: "Map the clients, facilities, devices and endpoints of an instance"
method: GET
path: "/api/v2/instance/mapping/{sequenceNumber}"
tags: ["Instance"]
---

# Map the clients, facilities, devices and endpoints of an instance

`GET /api/v2/instance/mapping/{sequenceNumber}`

## Request

- Base URL: `https://gear.cloud.studio`
- URL: `https://gear.cloud.studio/api/v2/instance/mapping/{sequenceNumber}`
- Auth: one of:
  - HTTP bearer
  - API key in query parameter `accessToken`

Returns the instance tree in batches: client, facility, device (with
its address) and endpoint, each with its identifier and description.
Start at 0, store the last sequence number received and repeat until
the list comes back empty. Only complete branches are returned, so a
device without endpoints does not appear. Requires the access token of
a global administrator.

## Path parameters

- `sequenceNumber` integer, required

## Query parameters

- `maxCount` integer

## Response `200`

A batch of the instance map. An empty list means there are no updates.

- object[]

## Other responses

- `500`: The request failed. A missing, invalid or expired access token is also reported this way.

---

[API](https://skmtc.dev/cloudstudioiot/apis/cloud-studio-iot-data-extraction-api.md) · [All operations](https://skmtc.dev/cloudstudioiot/apis/cloud-studio-iot-data-extraction-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cloudstudioiot/apis/cloud-studio-iot-data-extraction-api/revisions/1f497bcfbbb1?raw)