Session Templates

List session templates

Returns a paginated list of session templates.

get/session-templates

Request

  • Base URL
    https://api.metorial.com
  • Auth
    HTTP bearer

Query parameters

limitnumber
afterstring
beforestring
cursorstring
order'asc' | 'desc'
ownership'shared' | 'usable' | 'all'

Which resources to return under the resource ownership rules: shared (resources without an owner), usable (shared resources plus resources the caller can use), or all. Defaults to shared when ownership is enforced for the project and to all otherwise.

'active' | 'archived'
OR
string[]

Filter by status (active, archived)

string
OR
string[]

Filter by session template ID(s)

string
OR
string[]

Filter templates that include sessions with these IDs

string
OR
string[]

Filter templates that include session providers with these IDs

string
OR
string[]

Filter templates that include providers with these IDs

string
OR
string[]

Filter templates that include provider deployments with these IDs

string
OR
string[]

Filter templates that include provider configs with these IDs

string
OR
string[]

Filter templates that include provider auth configs with these IDs

gtstring date-time

Only include records after this timestamp for session template creation time

ltstring date-time

Only include records before this timestamp for session template creation time

Filter session template creation time by date range

gtstring date-time

Only include records after this timestamp for session template last update time

ltstring date-time

Only include records before this timestamp for session template last update time

Filter session template last update time by date range

Headers

Metorial-Versionstring
Example:2025-01-01

Pin the dated API version for this request, e.g. 2025-01-01. Defaults to the version configured for the environment.

Response

Successful response

Example response

{
  "items": [
    {
      "id": "stm_2bCdEfGhJkLmNpQr",
      "name": "Production Template",
      "description": "Template for production sessions",
      "providers": [
        {
          "id": "stp_3cDeFgHjKlMnPqRs",
          "provider_id": "pro_5gHjKlMnPqRsTuVw",
          "session_template_id": "stm_2bCdEfGhJkLmNpQr",
          "deployment": {
            "id": "pde_1aBcDeFgHjKlMnPq",
            "name": "Production",
            "description": "Production deployment",
            "provider_id": "pro_5gHjKlMnPqRsTuVw",
            "created_at": "2025-09-15T10:30:00.000Z",
            "updated_at": "2026-01-10T14:45:00.000Z"
          },
          "config": {
            "id": "pcf_7dEfGhJkLmNpQrSt",
            "name": "Production Config",
            "description": "Configuration for production environment",
            "provider_id": "pro_5gHjKlMnPqRsTuVw",
            "created_at": "2025-09-15T10:30:00.000Z",
            "updated_at": "2026-01-10T14:45:00.000Z"
          },
          "created_at": "2025-09-15T10:30:00.000Z",
          "updated_at": "2026-01-10T14:45:00.000Z"
        }
      ],
      "created_at": "2025-09-15T10:30:00.000Z",
      "updated_at": "2026-01-10T14:45:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.