Organizations

Manages organizations, projects and launch contexts

Experimental feature: this API is likely to change.

PreviousKey/Value Store NextRealtime

Last updated 22 days ago

Was this helpful?

Returns the details of an organization

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

The details for all organizations

Create organization

Creates a new organization.

post

Authorizations

Body

tenantIdstring

featuredEventIdstring

hasEventEnabledboolean

namestring · min: 1 · max: 64required

The name of an organization

websiteInfoobject

legalPoliciesobject

featuresobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","websiteInfo":{"headTags":[null]},"legalPolicies":{"termsOfService":[null],"privacyPolicy":[null],"chatRules":[null],"nvidiaPrivacyPolicy":[null],"eula":[null]},"features":{"loginOptions":{},"usernameCustomization":{"unique":true,"pattern":"text"},"pubnub":{"publishKey":"text","subscribeKey":"text","defaultChannels":[{"read":true,"write":true,"type":"party"}]}}}'

200

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

The details of the created organization

Get api keys

Retrieves the api keys of an organization.

get

/apiKeys/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/apiKeys/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

[
  {
    "documentId": "text",
    "displayName": "text",
    "isActive": true,
    "isManagedByTerraform": true,
    "organizationId": "text",
    "keyString": "text",
    "permissions": [
      "text"
    ],
    "claims": {
      "ANY_ADDITIONAL_PROPERTY": true
    }
  }
]

Response body for listing all API keys

Post api key

Creates a new api key for an organization.

post

/apiKeys/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

displayNamestringrequired

isActivebooleanrequired

permissionsstring[]required

claimsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/apiKeys/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"displayName":"text","isActive":true,"permissions":[null],"claims":{}}'

200

{
  "apiKey": "text"
}

Response body for creating a new API key

Patch api key

Updates an existing api key for an organization.

patch

/apiKeys/{apiKeyId}//

Path parameters

apiKeyIdstringrequired

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

displayNamestring

isActiveboolean

permissionsstring[]

claimsobject

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/apiKeys/{apiKeyId}/' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"permissions":[null],"claims":{}}'

200

{
  "documentId": "text",
  "displayName": "text",
  "isActive": true,
  "isManagedByTerraform": true,
  "organizationId": "text",
  "keyString": "text",
  "permissions": [
    "text"
  ],
  "claims": {
    "ANY_ADDITIONAL_PROPERTY": true
  }
}

Response body for updating an existing API key

Delete api key

Deletes an existing api key for an organization.

delete

/apiKeys/{apiKeyId}//

Path parameters

apiKeyIdstringrequired

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/apiKeys/{apiKeyId}/' \
  --header 'x-m2-organization-id: text'

204

No body

Default Response

Get organization detail

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

get

/current/

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/current/' \
  --header 'x-m2-organization-id: text'

200

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

The details for an organization

Update organization

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

patch

/current/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

namestring · min: 1 · max: 64

The name of an organization

featuredEventIdstring

featuresobject

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/current/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"features":{"loginOptions":{},"usernameCustomization":{"unique":true,"pattern":"text"},"pubnub":{"publishKey":"text","subscribeKey":"text","defaultChannels":[{"read":true,"write":true,"type":"party"}]}}}'

200

No body

Default Response

Delete organization

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

delete

/current/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/current/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

No body

Default Response

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.

patch

/current/pictureUrl/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/current/pictureUrl/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

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

The shape of an organization

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.

get

/projects/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/projects/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

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

The data of all the projects in an organization

Create project

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

post

/projects/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

namestring · min: 1 · max: 64required

The name of the project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/projects/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

{
  "projectId": "text"
}

The details of the created project

Get project details

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

get

/projects/current/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/projects/current/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

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

The details for a project

Update project

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

patch

/projects/current/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

documentIdstring

namestring · min: 1 · max: 64

The name of the project

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/projects/current/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json'

200

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

The details of the updated project

Delete project

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

delete

/projects/current/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/projects/current/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

No body

Default Response

Returns the details of a webhook endpoint

get

/webhooks/endpoints/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

[
  {
    "id": "text",
    "description": "text",
    "url": "text",
    "disabled": true,
    "rateLimit": 1,
    "createdAt": "2025-02-21T18:03:23.653Z",
    "updatedAt": "2025-02-21T18:03:23.653Z",
    "eventFilters": [
      "guest_link.consumed"
    ]
  }
]

The details for all webhook endpoints

Create a new webhook endpoint

post

/webhooks/endpoints/

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

descriptionstringrequired

The description of the webhook endpoint

urlstringrequired

The URL of the webhook endpoint

disabledboolean

Whether the webhook endpoint is disabled

rateLimitnumber

The rate limit for the webhook endpoint

eventFiltersany of[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"description":"text","url":"text","eventFilters":["guest_link.consumed"]}'

200

{
  "id": "text",
  "description": "text",
  "url": "text",
  "disabled": true,
  "rateLimit": 1,
  "createdAt": "2025-02-21T18:03:23.653Z",
  "updatedAt": "2025-02-21T18:03:23.653Z",
  "eventFilters": [
    "guest_link.consumed"
  ]
}

The details of the created webhook endpoint

Delete a webhook endpoint

delete

/webhooks/endpoints/{endpointId}//

Authorizations

Path parameters

endpointIdstringrequired

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

204

No body

Default Response

Returns the details of a webhook endpoint

get

/webhooks/endpoints/{endpointId}//

Authorizations

Path parameters

endpointIdstringrequired

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

{
  "id": "text",
  "description": "text",
  "url": "text",
  "disabled": true,
  "rateLimit": 1,
  "createdAt": "2025-02-21T18:03:23.653Z",
  "updatedAt": "2025-02-21T18:03:23.653Z",
  "eventFilters": [
    "guest_link.consumed"
  ]
}

The details for a webhook endpoint

Update a webhook endpoint

put

/webhooks/endpoints/{endpointId}//

Authorizations

Path parameters

endpointIdstringrequired

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

Body

descriptionstringrequired

The description of the webhook endpoint

urlstringrequired

The URL of the webhook endpoint

disabledboolean

Whether the webhook endpoint is disabled

rateLimitnumber

The rate limit for the webhook endpoint

eventFiltersany of[]required

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

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://your-organization-id.m2worlds.io/api/organizations/webhooks/endpoints/{endpointId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'Content-Type: application/json' \
  --data '{"description":"text","url":"text","eventFilters":["guest_link.consumed"]}'

200

{
  "id": "text",
  "description": "text",
  "url": "text",
  "disabled": true,
  "rateLimit": 1,
  "createdAt": "2025-02-21T18:03:23.653Z",
  "updatedAt": "2025-02-21T18:03:23.653Z",
  "eventFilters": [
    "guest_link.consumed"
  ]
}

The details of the updated webhook endpoint