Organizations

Manages organizations, projects and launch contexts

Experimental feature: this API is likely to change.

Returns the details of an organization

GEThttps://your-organization-id.m2worlds.io/api/organizations/

Authorization

BearerAuth

Response

200

The details for all organizations

Body

application/json

itemsany of

An organization with permissions

objectobject

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

[
  {
    "documentId": "text",
    "name": "text",
    "tenantId": "text",
    "pictureUrl": "text",
    "featuredEventId": "text",
    "websiteInfo": {
      "title": "text",
      "headTags": [
        "text"
      ]
    },
    "features": {
      "loginPanelDisclaimer": "text",
      "profilePictureUpload": false,
      "hasProfilePage": false,
      "hasCollectionsPage": false,
      "hasNavigationMenu": false,
      "allowPublicReadableChat": false,
      "loginOptions": {
        "hasEmail": false,
        "hasMetaMask": false,
        "hasWalletConnect": false,
        "hasCoinbaseWallet": false,
        "hasGoogle": false
      },
      "allowUserTokenManagement": false,
      "pubnub": {
        "publishKey": "text",
        "subscribeKey": "text",
        "defaultChannels": [
          {
            "read": false,
            "write": false,
            "type": "party"
          }
        ]
      },
      "usernameCustomization": {
        "unique": false,
        "pattern": "text"
      },
      "iosNativeClientSupport": false
    },
    "legalPolicies": {
      "termsOfService": [
        "text"
      ],
      "privacyPolicy": [
        "text"
      ],
      "chatRules": [
        "text"
      ],
      "nvidiaPrivacyPolicy": [
        "text"
      ],
      "eula": [
        "text"
      ]
    },
    "hasEventEnabled": false,
    "permissionVerb": "*",
    "isSlot": false
  }
]

Create organization

Creates a new organization.

POSThttps://your-organization-id.m2worlds.io/api/organizations/

Authorization

BearerAuth

Body

application/json

tenantIdstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

name*string

The name of an organization

Response

200

The details of the created organization

Body

application/json

organizationId*string

The ID of an organization

tenantId*string

features*object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "organizationId": "text",
  "tenantId": "text",
  "features": {
    "loginPanelDisclaimer": "text",
    "profilePictureUpload": false,
    "hasProfilePage": false,
    "hasCollectionsPage": false,
    "hasNavigationMenu": false,
    "allowPublicReadableChat": false,
    "loginOptions": {
      "hasEmail": false,
      "hasMetaMask": false,
      "hasWalletConnect": false,
      "hasCoinbaseWallet": false,
      "hasGoogle": false
    },
    "allowUserTokenManagement": false,
    "pubnub": {
      "publishKey": "text",
      "subscribeKey": "text",
      "defaultChannels": [
        {
          "read": false,
          "write": false,
          "type": "party"
        }
      ]
    },
    "usernameCustomization": {
      "unique": false,
      "pattern": "text"
    },
    "iosNativeClientSupport": false
  }
}

Get organization detail

Fetches the details of a specific organization by its organizationId. If the organization exists, the data is returned.

GEThttps://your-organization-id.m2worlds.io/api/organizations/current/

Header parameters

Response

200

The details for an organization

Body

application/json

name*OrganizationName (string)

The name of an organization

tenantIdstring

pictureUrlstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

organizationId*string

The ID of an organization

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/current/', {
    method: 'GET',
    headers: {
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

{
  "name": "text",
  "tenantId": "text",
  "pictureUrl": "text",
  "featuredEventId": "text",
  "websiteInfo": {
    "title": "text",
    "headTags": [
      "text"
    ]
  },
  "features": {
    "loginPanelDisclaimer": "text",
    "profilePictureUpload": false,
    "hasProfilePage": false,
    "hasCollectionsPage": false,
    "hasNavigationMenu": false,
    "allowPublicReadableChat": false,
    "loginOptions": {
      "hasEmail": false,
      "hasMetaMask": false,
      "hasWalletConnect": false,
      "hasCoinbaseWallet": false,
      "hasGoogle": false
    },
    "allowUserTokenManagement": false,
    "pubnub": {
      "publishKey": "text",
      "subscribeKey": "text",
      "defaultChannels": [
        {
          "read": false,
          "write": false,
          "type": "party"
        }
      ]
    },
    "usernameCustomization": {
      "unique": false,
      "pattern": "text"
    },
    "iosNativeClientSupport": false
  },
  "legalPolicies": {
    "termsOfService": [
      "text"
    ],
    "privacyPolicy": [
      "text"
    ],
    "chatRules": [
      "text"
    ],
    "nvidiaPrivacyPolicy": [
      "text"
    ],
    "eula": [
      "text"
    ]
  },
  "hasEventEnabled": false,
  "organizationId": "text"
}

Update organization

Allows updating specific fields (like name or featured event) for an organization. It checks for write permissions before processing the request.

PATCHhttps://your-organization-id.m2worlds.io/api/organizations/current/

Authorization

BearerAuth

Header parameters

Body

application/json

namestring

The name of an organization

featuredEventIdstring

featuresobject

Response

200

Default Response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/current/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete organization

Deletes organization and its related resources. It requires the user to have full permissions (:) to perform the deletion.

DELETEhttps://your-organization-id.m2worlds.io/api/organizations/current/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/current/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Updates picture URL of organization

Updates the picture URL for an organization. A file is uploaded, transformed, and stored in Cloud Storage, with the resulting URL saved in the organization's record.

PATCHhttps://your-organization-id.m2worlds.io/api/organizations/current/pictureUrl/

Authorization

BearerAuth

Header parameters

Response

200

The shape of an organization

Body

application/json

documentId*organizationId (string)

The ID of an organization

name*OrganizationName (string)

The name of an organization

tenantIdstring

pictureUrlstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/current/pictureUrl/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

{
  "documentId": "text",
  "name": "text",
  "tenantId": "text",
  "pictureUrl": "text",
  "featuredEventId": "text",
  "websiteInfo": {
    "title": "text",
    "headTags": [
      "text"
    ]
  },
  "features": {
    "loginPanelDisclaimer": "text",
    "profilePictureUpload": false,
    "hasProfilePage": false,
    "hasCollectionsPage": false,
    "hasNavigationMenu": false,
    "allowPublicReadableChat": false,
    "loginOptions": {
      "hasEmail": false,
      "hasMetaMask": false,
      "hasWalletConnect": false,
      "hasCoinbaseWallet": false,
      "hasGoogle": false
    },
    "allowUserTokenManagement": false,
    "pubnub": {
      "publishKey": "text",
      "subscribeKey": "text",
      "defaultChannels": [
        {
          "read": false,
          "write": false,
          "type": "party"
        }
      ]
    },
    "usernameCustomization": {
      "unique": false,
      "pattern": "text"
    },
    "iosNativeClientSupport": false
  },
  "legalPolicies": {
    "termsOfService": [
      "text"
    ],
    "privacyPolicy": [
      "text"
    ],
    "chatRules": [
      "text"
    ],
    "nvidiaPrivacyPolicy": [
      "text"
    ],
    "eula": [
      "text"
    ]
  },
  "hasEventEnabled": false
}

Get launch contexts of organization

Fetches the launch contexts for a specific organization based on the organizationId. Includes relevant project and world information as well as any associated picture URLs.

GEThttps://your-organization-id.m2worlds.io/api/organizations/launchContexts/

Header parameters

Response

200

The launch contexts for an organization

Body

application/json

launchContextId*string

name*string

isActive*boolean

Defines whether the launch context is live

publicDownloadany of

objectnull

isWorldTravelOnlyboolean

worldIdall of

descriptionstring

errorPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out

Pattern: ^https?://.*$

okPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully

Pattern: ^https?://.*$

gdnStreamingany of

objectnull

ubitusStreamingany of

objectnull

streamManagerany of

objectnull

bypassBrowserRestrictionsboolean

Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.

enableQueueboolean

capacityany of

numbernull

buildInfoany of

objectnull

splashScreenUrlstring

deploymentobject

useWorldSessionsboolean

pictureUrlall of

organizationId*string

The ID of an organization

projectId*string

The ID of a project

isPublicboolean

artifactUrlstring

permissionVerb*any of

The permission level that the user has over this resource.

enumenumenum

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/launchContexts/', {
    method: 'GET',
    headers: {
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "launchContextId": "text",
    "name": "text",
    "isActive": false,
    "publicDownload": {
      "enabled": false,
      "enforceAntiCheat": false,
      "allowMac": false,
      "allowIos": false
    },
    "isWorldTravelOnly": false,
    "worldId": {},
    "description": "text",
    "errorPageUrl": "text",
    "okPageUrl": "text",
    "gdnStreaming": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab",
      "useCustomClient": false,
      "useWindowedMode": false
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": false,
      "showProviderOptions": false,
      "useBuildVersion": false
    },
    "bypassBrowserRestrictions": false,
    "enableQueue": false,
    "capacity": 0,
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "splashScreenUrl": "text",
    "deployment": {
      "region": "text",
      "version": "text"
    },
    "useWorldSessions": false,
    "pictureUrl": {},
    "organizationId": "text",
    "projectId": "text",
    "isPublic": false,
    "artifactUrl": "text",
    "permissionVerb": "*"
  }
]

Returns the projects of organization

Retrieves all the projects associated with a specific organization, returning the list of projects the user has access to based on their permissions.

GEThttps://your-organization-id.m2worlds.io/api/organizations/projects/

Authorization

BearerAuth

Header parameters

Response

200

The data of all the projects in an organization

Body

application/json

itemsany of

objectobject

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/projects/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "documentId": "text",
    "name": "text",
    "projectId": "text",
    "permissionVerb": "*"
  }
]

Create project

Allows creating a new project within an organization. The user must have write permissions to the organization to successfully create the project.

POSThttps://your-organization-id.m2worlds.io/api/organizations/projects/

Authorization

BearerAuth

Header parameters

Body

application/json

name*string

The name of the project

Response

200

The details of the created project

Body

application/json

projectId*string

The ID of a project

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/projects/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "projectId": "text"
}

Get project details

Retrieves details of a specific project within an organization. Access is controlled by read permissions on the project.

GEThttps://your-organization-id.m2worlds.io/api/organizations/projects/current/

Authorization

BearerAuth

Header parameters

Response

200

The details for a project

Body

application/json

documentId*string

name*string

The name of the project

permissionVerb*any of

enumenum

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/projects/current/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

200

{
  "documentId": "text",
  "name": "text",
  "permissionVerb": "*"
}

Update project

Updates a project’s attributes, such as the project name. The user needs write permissions on the project to make changes.

PATCHhttps://your-organization-id.m2worlds.io/api/organizations/projects/current/

Authorization

BearerAuth

Header parameters

Body

application/json

documentIdstring

namestring

The name of the project

Response

200

The details of the updated project

Body

application/json

documentIdstring

namestring

The name of the project

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/projects/current/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "documentId": "text",
  "name": "text"
}

Delete project

Deletes a project and its associated resources. Requires write permissions for the project and its children.

DELETEhttps://your-organization-id.m2worlds.io/api/organizations/projects/current/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/projects/current/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Get launch contexts of organization

Fetches the launch contexts for a specific organization and project based on the organization ID and project ID in the headers. Includes relevant project and world information as well as any associated picture URLs.

GEThttps://your-organization-id.m2worlds.io/api/organizations/projects/launchContexts/

Query parameters

Header parameters

Response

200

The launch cofntexts for an organization

Body

application/json

launchContextId*string

name*string

isActive*boolean

Defines whether the launch context is live

publicDownloadany of

objectnull

isWorldTravelOnlyboolean

worldIdall of

descriptionstring

errorPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out

Pattern: ^https?://.*$

okPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully

Pattern: ^https?://.*$

gdnStreamingany of

objectnull

ubitusStreamingany of

objectnull

streamManagerany of

objectnull

bypassBrowserRestrictionsboolean

Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.

enableQueueboolean

capacityany of

numbernull

buildInfoany of

objectnull

splashScreenUrlstring

deploymentobject

useWorldSessionsboolean

pictureUrlall of

organizationId*string

The ID of an organization

projectId*string

The ID of a project

isPublicboolean

artifactUrlstring

permissionVerb*any of

The permission level that the user has over this resource.

enumenumenum

documentId*string

This is a legacy field and should avoid being used where possible

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/projects/launchContexts/', {
    method: 'GET',
    headers: {
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "launchContextId": "text",
    "name": "text",
    "isActive": false,
    "publicDownload": {
      "enabled": false,
      "enforceAntiCheat": false,
      "allowMac": false,
      "allowIos": false
    },
    "isWorldTravelOnly": false,
    "worldId": {},
    "description": "text",
    "errorPageUrl": "text",
    "okPageUrl": "text",
    "gdnStreaming": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab",
      "useCustomClient": false,
      "useWindowedMode": false
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": false,
      "showProviderOptions": false,
      "useBuildVersion": false
    },
    "bypassBrowserRestrictions": false,
    "enableQueue": false,
    "capacity": 0,
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "splashScreenUrl": "text",
    "deployment": {
      "region": "text",
      "version": "text"
    },
    "useWorldSessions": false,
    "pictureUrl": {},
    "organizationId": "text",
    "projectId": "text",
    "isPublic": false,
    "artifactUrl": "text",
    "permissionVerb": "*",
    "documentId": "text"
  }
]

Gets a launch context

Get the attributes of the given Launch Context.

GEThttps://your-organization-id.m2worlds.io/api/organizations/projects/launchContexts/current/

Authorization

BearerAuth

Header parameters

Response

200

The attributes of a launch context

Body

application/json

launchContextIdstring

namestring

isActiveboolean

Defines whether the launch context is live

publicDownloadany of

objectnull

isWorldTravelOnlyboolean

worldIdstring

descriptionstring

errorPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out

Pattern: ^https?://.*$

okPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully

Pattern: ^https?://.*$

gdnStreamingany of

objectnull

ubitusStreamingany of

objectnull

streamManagerany of

objectnull

bypassBrowserRestrictionsboolean

Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.

enableQueueboolean

capacityany of

numbernull

buildInfoany of

objectnull

splashScreenUrlstring

deploymentobject

useWorldSessionsboolean

pictureUrlstring

isPublicboolean

gdnAppIdstring

documentIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/projects/launchContexts/current/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "x-m2-launch-context-id": "text"
    },
});
const data = await response.json();

Response

200

{
  "launchContextId": "text",
  "name": "text",
  "isActive": false,
  "publicDownload": {
    "enabled": false,
    "enforceAntiCheat": false,
    "allowMac": false,
    "allowIos": false
  },
  "isWorldTravelOnly": false,
  "worldId": "text",
  "description": "text",
  "errorPageUrl": "text",
  "okPageUrl": "text",
  "gdnStreaming": {
    "cmsId": "text",
    "authorizationId": "text",
    "launchMode": "same-tab",
    "useCustomClient": false,
    "useWindowedMode": false
  },
  "ubitusStreaming": {
    "gameLabel": "text",
    "gameChannel": "text"
  },
  "streamManager": {
    "streamContextId": "text",
    "allowForceProvider": false,
    "showProviderOptions": false,
    "useBuildVersion": false
  },
  "bypassBrowserRestrictions": false,
  "enableQueue": false,
  "capacity": 0,
  "buildInfo": {
    "buildChannelId": "text",
    "buildTag": "text",
    "buildType": "client"
  },
  "splashScreenUrl": "text",
  "deployment": {
    "region": "text",
    "version": "text"
  },
  "useWorldSessions": false,
  "pictureUrl": "text",
  "isPublic": false,
  "gdnAppId": "text",
  "documentId": "text"
}

Update launch context

Updates a launch context's attributes, such as the name. The user needs write permissions on the launch context to make changes.

PATCHhttps://your-organization-id.m2worlds.io/api/organizations/projects/launchContexts/current/

Authorization

BearerAuth

Header parameters

Body

application/json

launchContextIdstring

namestring

isActiveboolean

Defines whether the launch context is live

publicDownloadany of

objectnull

isWorldTravelOnlyboolean

worldIdstring

descriptionstring

errorPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out

Pattern: ^https?://.*$

okPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully

Pattern: ^https?://.*$

gdnStreamingany of

objectnull

ubitusStreamingany of

objectnull

streamManagerany of

objectnull

bypassBrowserRestrictionsboolean

Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.

enableQueueboolean

capacityany of

numbernull

buildInfoany of

objectnull

splashScreenUrlstring

deploymentobject

useWorldSessionsboolean

pictureUrlstring

isPublicboolean

gdnAppIdstring

Response

200

The details of the updated launch context

Body

application/json

launchContextIdstring

namestring

isActiveboolean

Defines whether the launch context is live

publicDownloadany of

objectnull

isWorldTravelOnlyboolean

worldIdstring

descriptionstring

errorPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context errors out

Pattern: ^https?://.*$

okPageUrlstring

Defines the URL that a user will be redirected to if the web stream for the world linked to the launch context finishes successfully

Pattern: ^https?://.*$

gdnStreamingany of

objectnull

ubitusStreamingany of

objectnull

streamManagerany of

objectnull

bypassBrowserRestrictionsboolean

Different streaming services have different restrictions on which browsers they support. Whether a user can access the stream based on their browser is determined on the client. If set to 'true', the user will be able to access the stream regardless of their browser, provided the client is set up to support this functionality.

enableQueueboolean

capacityany of

numbernull

buildInfoany of

objectnull

splashScreenUrlstring

deploymentobject

useWorldSessionsboolean

pictureUrlstring

isPublicboolean

gdnAppIdstring

documentIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/projects/launchContexts/current/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "x-m2-launch-context-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "launchContextId": "text",
  "name": "text",
  "isActive": false,
  "publicDownload": {
    "enabled": false,
    "enforceAntiCheat": false,
    "allowMac": false,
    "allowIos": false
  },
  "isWorldTravelOnly": false,
  "worldId": "text",
  "description": "text",
  "errorPageUrl": "text",
  "okPageUrl": "text",
  "gdnStreaming": {
    "cmsId": "text",
    "authorizationId": "text",
    "launchMode": "same-tab",
    "useCustomClient": false,
    "useWindowedMode": false
  },
  "ubitusStreaming": {
    "gameLabel": "text",
    "gameChannel": "text"
  },
  "streamManager": {
    "streamContextId": "text",
    "allowForceProvider": false,
    "showProviderOptions": false,
    "useBuildVersion": false
  },
  "bypassBrowserRestrictions": false,
  "enableQueue": false,
  "capacity": 0,
  "buildInfo": {
    "buildChannelId": "text",
    "buildTag": "text",
    "buildType": "client"
  },
  "splashScreenUrl": "text",
  "deployment": {
    "region": "text",
    "version": "text"
  },
  "useWorldSessions": false,
  "pictureUrl": "text",
  "isPublic": false,
  "gdnAppId": "text",
  "documentId": "text"
}

Returns the details of a slot organization

Retrieves details of a slot organization. Ensures the organization is active before returning its data. If the organization is not a slot or inactive, access is forbidden.

GEThttps://your-organization-id.m2worlds.io/api/organizations/slots/

Header parameters

Response

200

The details for an organization

Body

application/json

name*OrganizationName (string)

The name of an organization

tenantIdstring

pictureUrlstring

featuredEventIdstring

websiteInfoobject

featuresobject

legalPoliciesobject

hasEventEnabledboolean

organizationId*string

The ID of an organization

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/slots/', {
    method: 'GET',
    headers: {
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

{
  "name": "text",
  "tenantId": "text",
  "pictureUrl": "text",
  "featuredEventId": "text",
  "websiteInfo": {
    "title": "text",
    "headTags": [
      "text"
    ]
  },
  "features": {
    "loginPanelDisclaimer": "text",
    "profilePictureUpload": false,
    "hasProfilePage": false,
    "hasCollectionsPage": false,
    "hasNavigationMenu": false,
    "allowPublicReadableChat": false,
    "loginOptions": {
      "hasEmail": false,
      "hasMetaMask": false,
      "hasWalletConnect": false,
      "hasCoinbaseWallet": false,
      "hasGoogle": false
    },
    "allowUserTokenManagement": false,
    "pubnub": {
      "publishKey": "text",
      "subscribeKey": "text",
      "defaultChannels": [
        {
          "read": false,
          "write": false,
          "type": "party"
        }
      ]
    },
    "usernameCustomization": {
      "unique": false,
      "pattern": "text"
    },
    "iosNativeClientSupport": false
  },
  "legalPolicies": {
    "termsOfService": [
      "text"
    ],
    "privacyPolicy": [
      "text"
    ],
    "chatRules": [
      "text"
    ],
    "nvidiaPrivacyPolicy": [
      "text"
    ],
    "eula": [
      "text"
    ]
  },
  "hasEventEnabled": false,
  "organizationId": "text"
}

Returns the details of a webhook endpoint

GEThttps://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/

Authorization

BearerAuth

Header parameters

Response

200

The details for all webhook endpoints

Body

application/json

id*string

The generated ID of the webhook endpoint

description*string

The description of the webhook endpoint

url*string

The URL of the webhook endpoint

disabledboolean

Whether the webhook endpoint is disabled

rateLimitnumber

The rate limit for the webhook endpoint

createdAt*string (date-time)

The date and time the webhook endpoint was created

updatedAt*string (date-time)

The date and time the webhook endpoint was last updated

eventFilters*array of any of

The list of event types that the webhook endpoint is subscribed to

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "description": "text",
    "url": "text",
    "disabled": false,
    "rateLimit": 0,
    "createdAt": "2024-12-21T11:36:32.981Z",
    "updatedAt": "2024-12-21T11:36:32.981Z",
    "eventFilters": [
      "guest_link.consumed"
    ]
  }
]

Create a new webhook endpoint

POSThttps://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/

Authorization

BearerAuth

Header parameters

Body

application/json

description*string

The description of the webhook endpoint

url*string

The URL of the webhook endpoint

disabledboolean

Whether the webhook endpoint is disabled

rateLimitnumber

The rate limit for the webhook endpoint

eventFilters*array of any of

The list of event types that the webhook endpoint is subscribed to

Response

200

The details of the created webhook endpoint

Body

application/json

id*string

The generated ID of the webhook endpoint

description*string

The description of the webhook endpoint

url*string

The URL of the webhook endpoint

disabledboolean

Whether the webhook endpoint is disabled

rateLimitnumber

The rate limit for the webhook endpoint

createdAt*string (date-time)

The date and time the webhook endpoint was created

updatedAt*string (date-time)

The date and time the webhook endpoint was last updated

eventFilters*array of any of

The list of event types that the webhook endpoint is subscribed to

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "url": "text",
      "eventFilters": [
        "guest_link.consumed"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "description": "text",
  "url": "text",
  "disabled": false,
  "rateLimit": 0,
  "createdAt": "2024-12-21T11:36:32.981Z",
  "updatedAt": "2024-12-21T11:36:32.981Z",
  "eventFilters": [
    "guest_link.consumed"
  ]
}

Delete a webhook endpoint

DELETEhttps://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/

Authorization

BearerAuth

Path parameters

endpointId*string

Header parameters

Response

204

Default Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Returns the details of a webhook endpoint

GEThttps://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/

Authorization

BearerAuth

Path parameters

endpointId*string

Header parameters

Response

200

The details for a webhook endpoint

Body

application/json

id*string

The generated ID of the webhook endpoint

description*string

The description of the webhook endpoint

url*string

The URL of the webhook endpoint

disabledboolean

Whether the webhook endpoint is disabled

rateLimitnumber

The rate limit for the webhook endpoint

createdAt*string (date-time)

The date and time the webhook endpoint was created

updatedAt*string (date-time)

The date and time the webhook endpoint was last updated

eventFilters*array of any of

The list of event types that the webhook endpoint is subscribed to

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "text",
  "description": "text",
  "url": "text",
  "disabled": false,
  "rateLimit": 0,
  "createdAt": "2024-12-21T11:36:32.981Z",
  "updatedAt": "2024-12-21T11:36:32.981Z",
  "eventFilters": [
    "guest_link.consumed"
  ]
}

Update a webhook endpoint

PUThttps://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/

Authorization

BearerAuth

Path parameters

endpointId*string

Header parameters

Body

application/json

description*string

The description of the webhook endpoint

url*string

The URL of the webhook endpoint

disabledboolean

Whether the webhook endpoint is disabled

rateLimitnumber

The rate limit for the webhook endpoint

eventFilters*array of any of

The list of event types that the webhook endpoint is subscribed to

Response

200

The details of the updated webhook endpoint

Body

application/json

id*string

The generated ID of the webhook endpoint

description*string

The description of the webhook endpoint

url*string

The URL of the webhook endpoint

disabledboolean

Whether the webhook endpoint is disabled

rateLimitnumber

The rate limit for the webhook endpoint

createdAt*string (date-time)

The date and time the webhook endpoint was created

updatedAt*string (date-time)

The date and time the webhook endpoint was last updated

eventFilters*array of any of

The list of event types that the webhook endpoint is subscribed to

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "url": "text",
      "eventFilters": [
        "guest_link.consumed"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "description": "text",
  "url": "text",
  "disabled": false,
  "rateLimit": 0,
  "createdAt": "2024-12-21T11:36:32.981Z",
  "updatedAt": "2024-12-21T11:36:32.981Z",
  "eventFilters": [
    "guest_link.consumed"
  ]
}