---
title: "GET /v1/platforms/{id}"
method: GET
path: "/v1/platforms/{id}"
tags: ["platforms"]
---

# GET /v1/platforms/{id}

`GET /v1/platforms/{id}`

Get a platform by id

## Path parameters

- `id` string, required

## Response `200`

Default Response

- object
  - `federatedAuthProviders` object, required
    - `google` object
      - `clientId` string, required
    - `github` object
      - `clientId` string, required
    - `saml` object
  - `defaultLocale` string, nullable
  - `copilotSettings` object
    - `providers` object, required
      - `openai` object
      - `azureOpenai` object
  - `smtp` object
  - `id` string, required
  - `created` string, required
  - `updated` string, required
  - `ownerId` string, required
  - `name` string, required
  - `primaryColor` string, required
  - `logoIconUrl` string, required
  - `fullLogoUrl` string, required
  - `favIconUrl` string, required
  - `filteredPieceNames` string[], required
  - `filteredPieceBehavior` union, required
    - 'ALLOWED'
    - 'BLOCKED'
  - `cloudAuthEnabled` boolean, required
  - `analyticsEnabled` boolean, required
  - `showPoweredBy` boolean, required
  - `environmentsEnabled` boolean, required
  - `auditLogEnabled` boolean, required
  - `embeddingEnabled` boolean, required
  - `managePiecesEnabled` boolean, required
  - `manageTemplatesEnabled` boolean, required
  - `customAppearanceEnabled` boolean, required
  - `manageProjectsEnabled` boolean, required
  - `projectRolesEnabled` boolean, required
  - `customDomainsEnabled` boolean, required
  - `globalConnectionsEnabled` boolean, required
  - `customRolesEnabled` boolean, required
  - `apiKeysEnabled` boolean, required
  - `flowIssuesEnabled` boolean, required
  - `alertsEnabled` boolean, required
  - `ssoEnabled` boolean, required
  - `enforceAllowedAuthDomains` boolean, required
  - `allowedAuthDomains` string[], required
  - `emailAuthEnabled` boolean, required
  - `pinnedPieces` string[], required

## Changes

- **2024-12-31** `3c05b427e5b5` — 1 breaking, 1 warning, 2 info
  - removed the required property `gitSyncEnabled` from the response with the `200` status
  - removed the optional property `licenseKey` from the response with the `200` status
  - added the optional property `copilotSettings` to the response with the `200` status
  - added the required property `environmentsEnabled` to the response with the `200` status
- **2024-11-25** `086c2138cb1b` — 2 info
  - added the required property `customRolesEnabled` to the response with the `200` status
  - added the required property `globalConnectionsEnabled` to the response with the `200` status
- **2024-11-12** `499ae054e9e9` — 1 breaking, 7 warning, 3 info
  - removed the required property `premiumPieces` from the response with the `200` status
  - removed the optional property `privacyPolicyUrl` from the response with the `200` status
  - removed the optional property `smtpHost` from the response with the `200` status
  - removed the optional property `smtpPort` from the response with the `200` status
  - …7 more
- **2024-09-03** `b95c8c8e8262` — 1 info
  - added the required property `analyticsEnabled` to the response with the `200` status
- **2024-06-11** `a1d1c2fbc615` — 1 info
  - endpoint added

[Full history](https://skmtc.dev/activeboxes/apis/activeboxes-documentation/changes/v1/platforms/:id/get.md)

---

[API](https://skmtc.dev/activeboxes/apis/activeboxes-documentation.md) · [All operations](https://skmtc.dev/activeboxes/apis/activeboxes-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/activeboxes/activeboxes-documentation/revisions/12c564515962/schema)