GET /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments — openapi

Lists experiments for a universe.

Pagination is offset-based (maxPageSize + skip). The response carries the page slice plus the unpaginated total matching the filters. Request includes optional pagination, search, and filters.

Endpoint

Method: GET

Path: /creator-configs-public-api/v1/experimentation/universes/{universeId}/experiments

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required
universeId	path	true
maxPageSize	query	false
skip	query	false
searchKey	query	false
stateFilters	query	false
sortOrder	query	false
sortKey	query	false
productTypeFilter	query	false

[
  {
    "name": "universeId",
    "in": "path",
    "required": true,
    "schema": {
      "type": "integer",
      "format": "int64"
    }
  },
  {
    "name": "maxPageSize",
    "in": "query",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "skip",
    "in": "query",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "searchKey",
    "in": "query",
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "stateFilters",
    "in": "query",
    "schema": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ExperimentState"
      }
    },
    "x-enum-varnames": [
      "Draft",
      "Scheduled",
      "Running",
      "Completed",
      "Cancelled",
      "Deleted"
    ]
  },
  {
    "name": "sortOrder",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "x-enum-varnames": [
      "Ascending",
      "Descending"
    ]
  },
  {
    "name": "sortKey",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "x-enum-varnames": [
      "Name",
      "LastModifiedTime",
      "StartTime",
      "Relevance"
    ]
  },
  {
    "name": "productTypeFilter",
    "in": "query",
    "schema": {
      "type": "string"
    },
    "x-enum-varnames": [
      "InGameConfigs",
      "Matchmaking"
    ]
  }
]

Responses

Status	Description
200	OK
400	Bad Request
401	Unauthorized
404	Not Found

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ListExperimentsResponse"
        }
      }
    }
  },
  "400": {
    "description": "Bad Request",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ActionResult"
        }
      }
    }
  },
  "401": {
    "description": "Unauthorized",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ActionResult"
        }
      }
    }
  },
  "404": {
    "description": "Not Found",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ActionResult"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe:read"
      ]
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "name": "x-api-key",
      "in": "header"
    },
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {}
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Experiments"
  ],
  "summary": "Lists experiments for a universe.",
  "description": "Pagination is offset-based (`maxPageSize` + `skip`). The response carries the page slice plus the unpaginated total\r\nmatching the filters. Request includes optional pagination, search, and filters.",
  "operationId": "PublicExperimentation_ListExperiments",
  "parameters": [
    {
      "name": "universeId",
      "in": "path",
      "required": true,
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "maxPageSize",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "skip",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "searchKey",
      "in": "query",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "stateFilters",
      "in": "query",
      "schema": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/ExperimentState"
        }
      },
      "x-enum-varnames": [
        "Draft",
        "Scheduled",
        "Running",
        "Completed",
        "Cancelled",
        "Deleted"
      ]
    },
    {
      "name": "sortOrder",
      "in": "query",
      "schema": {
        "type": "string"
      },
      "x-enum-varnames": [
        "Ascending",
        "Descending"
      ]
    },
    {
      "name": "sortKey",
      "in": "query",
      "schema": {
        "type": "string"
      },
      "x-enum-varnames": [
        "Name",
        "LastModifiedTime",
        "StartTime",
        "Relevance"
      ]
    },
    {
      "name": "productTypeFilter",
      "in": "query",
      "schema": {
        "type": "string"
      },
      "x-enum-varnames": [
        "InGameConfigs",
        "Matchmaking"
      ]
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ListExperimentsResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad Request",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ActionResult"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ActionResult"
          }
        }
      }
    },
    "404": {
      "description": "Not Found",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ActionResult"
          }
        }
      }
    }
  },
  "x-roblox-stability": "EXPERIMENTAL",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "MINUTE",
      "maxInPeriod": 100
    },
    "perOauth2Authorization": {
      "period": "MINUTE",
      "maxInPeriod": 100
    }
  },
  "x-roblox-scopes": [
    {
      "name": "universe:read",
      "targetResourceSpecifier": "universes"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    },
    {
      "roblox-oauth2": [
        "universe:read"
      ]
    }
  ],
  "externalDocs": {
    "url": "https://create.roblox.com/docs/cloud/reference/features/experiments#PublicExperimentation_ListExperiments"
  }
}