Get Platform by name

GET 
/api/v1/platforms/:platformId

Get Platform by name

Request

Path Parameters

platformId numberrequired

ID of the platform

Responses

200

application/json

Schema

Schema

name stringrequired

Name of the platform

description string

Description of the platform

imageId string

Optional image ID

metadata object

Optional tags or metadata

id numberrequired

ID of the platform

createdAt date-timerequired

Timestamp when the platform was created

updatedAt date-timerequired

Timestamp when the platform was last updated

Example (from schema)

{
  "name": "string",
  "description": "This is a sample platform.",
  "imageId": "string",
  "metadata": {},
  "id": 0,
  "createdAt": "2026-09-10T14:32:46.392Z",
  "updatedAt": "2026-09-10T14:32:46.392Z"
}

Loading...