Retrieve

client.platform.retrieve(?): PlatformRetrieveResponse { data }

GET/platform

Gets platform details for the workspace

ReturnsExpand Collapse

PlatformRetrieveResponse { data }

data: Data { created, displayName, workspaceId, modified }

Platform object

created: string

ISO 8601 timestamp when the platform was created

formatdate-time

displayName: string

Display name for the platform

workspaceId: string

Workspace ID this platform belongs to

modified?: string

ISO 8601 timestamp when the platform was last modified

formatdate-time

Retrieve

import Fragment from '@fragment-dev/ts-node';

const client = new Fragment();

const platform = await client.platform.retrieve();

console.log(platform.data);

{
  "data": {
    "created": "2024-01-13T00:00:00Z",
    "displayName": "Acme Corp",
    "workspaceId": "ws_1234567890",
    "modified": "2024-01-14T00:00:00Z"
  }
}

Returns Examples

{
  "data": {
    "created": "2024-01-13T00:00:00Z",
    "displayName": "Acme Corp",
    "workspaceId": "ws_1234567890",
    "modified": "2024-01-14T00:00:00Z"
  }
}