Cloud APIs
EngineApi
instanceChildren

instanceChildren

Gets children for an Instance.

Parameters

NameTypeDescription
universeIdUniverseIdThe ID of the universe to get the Instance children from.
placeIdPlaceIdThe ID of the place to get the Instance children from.
instanceIdInstanceIdThe ID of the Instance to get children for.
limit?numberThe maximum number of child instance to return. The service may return fewer than this value. If unspecified, at most 200 children will be returned. The maximum value is 200; values above 200 will be coerced to 200.
cursor?stringThe paging cursor for the previous or next page.

Example

const { data: children } = await EngineApi.instanceChildren({
  universeId: 5795192361,
  placeId: 16866553538,
  instanceId: "root",
}); 

Example Data

{
  path: "universes/5795192361/places/16866553538/instances/root/operations/1a9a74a7-c687-492d-8035-759b29295867",
  done: true,
  response: {
    "@type": "type.googleapis.com/roblox.open_cloud.cloud.v2.ListInstanceChildrenResponse",
    instances: [
      {
        path: "universes/5795192361/places/16866553538/instances/44b188da-ce63-2b47-02e9-c68d004815fc",
        hasChildren: true,
        engineInstance: {
          id: "44b188da-ce63-2b47-02e9-c68d004815fc",
          parent: "649b6a4b-51bf-b866-0691-76d800000001",
          name: "Workspace",
          details: {},
        },
      },
    ],
    nextPageToken: "",
  },
} 

Endpoint

GET /v2/universes/{universeId}/places/{placeId}/instances/{instanceId}:listChildren