latestOpenAPI 3.1.02026-08-101974116.4 KB

fe3e2eee3c6f

Worlds

public

Get worlds for an organization

Retrieves and returns all worlds that belong to the given Organization. Can also additionally filter by project if a project ID is passed in the headers.

get/

Headers

x-m2-organization-idstring required

The ID of an organization

x-m2-project-idstring

The ID of a project

Response

Lists all worlds for an organization or project (if specified)

documentIdstring required

The ID of a world

namestring required

The name of a world

descriptionstring

The description of a world

pictureUrlstring uri

The picture URL of a world

transientboolean required

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.

organizationIdstring required

The ID of an organization

projectIdstring required

The ID of a project