# Platform

## Retrieve

`client.platform.retrieve(RequestOptionsoptions?): PlatformRetrieveResponse`

**get** `/platform`

Gets platform details for the workspace

### Returns

- `PlatformRetrieveResponse`

  - `data: Data`

    Platform object

    - `created: string`

      ISO 8601 timestamp when the platform was created

    - `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

### Example

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

const client = new Fragment();

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

console.log(platform.data);
```

## Update

`client.platform.update(PlatformUpdateParamsbody, RequestOptionsoptions?): PlatformUpdateResponse`

**post** `/platform`

Updates platform details (creates if not exists)

### Parameters

- `body: PlatformUpdateParams`

  - `displayName: string`

    Display name for the platform

### Returns

- `PlatformUpdateResponse`

  - `data: Data`

    Platform object

    - `created: string`

      ISO 8601 timestamp when the platform was created

    - `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

### Example

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

const client = new Fragment();

const platform = await client.platform.update({ displayName: 'Acme Corp' });

console.log(platform.data);
```