# List Platforms

See how people reach Cirra from Teams and Slack, and which roles they get.

`GET https://connect.mindcloud.co/v2/platforms`

Permissions: `company:view`.

## Parameters

### Headers

- `X-Company-Id` (string): Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See [Organizations](https://mindcloud.co/docs/api/rest/introduction/organizations).

## Example request

```bash
curl --request GET \
  --url 'https://connect.mindcloud.co/v2/platforms' \
  --header 'Authorization: Bearer $MINDCLOUD_API_TOKEN'
```

## Response fields

- `id` (string): The platform: microsoft (Teams) or slack.
  Allowed values:
    - `microsoft`
    - `slack`
- `isConnected` (boolean): True once a workspace or tenant was connected in Cirra. Connecting proves ownership of it, so it is done in Cirra, not through the API.
- `directoryId` (string): The connected Slack workspace or Microsoft tenant id.
- `directoryName` (string): Its name.
- `allowedEmailDomains` (array of string): Email domains whose people may sign in through the platform. Consumer domains such as gmail.com are refused.
- `autoCreateUsers` (boolean): True when people from those domains who have no MindCloud account get one when they first sign in.
- `defaultRoleId` (string): The role new people get when no group mapping applies and no unmapped role is set (List Roles).
- `allowGuests` (boolean): True when guests of the tenant or workspace may sign in.
- `roleMappings` (array of objects): Which directory group grants which role. The first group a person is in decides.
  - `groupId` (string): The directory group id.
  - `roleId` (string): The role it grants (List Roles).
- `unmappedRoleId` (string): The role for someone in none of the mapped groups. Null: they are refused.