---
title: "Get the roster-sync policy (who joins from Slack)"
method: GET
path: "/v1/roster-sync-policy"
tags: ["roster-sync-policy"]
---

# Get the roster-sync policy (who joins from Slack)

`GET /v1/roster-sync-policy`

## Request

- Base URL: `https://api.patricia.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.patricia.app/v1/roster-sync-policy`
- Auth: HTTP bearer

Which tiers of Slack member join Patricia when the workspace roster syncs: full workspace members and, only if enabled, guests (single and multi-channel). Guests are excluded by default. Any workspace member may read it.

## Headers

- `X-Tenant-Id` string, nullable

## Response `200`

Successful Response

- RosterSyncPolicyResponse: The tenant's effective roster-sync policy (admin view).
  - `include_full_members` boolean, required
  - `include_multi_channel_guests` boolean, required
  - `include_single_channel_guests` boolean, required
  - `admins_only` boolean, required
  - `include_guests` boolean, required

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden. Inspect response body `code` for the specific reason (for example: PERMISSION_DENIED, EMAIL_NOT_VERIFIED, TENANT_ACCESS_REQUIRED, ROLE_UNRESOLVED)
- `404`: Not found
- `422`: Validation error

---

[API](https://skmtc.dev/patricia/apis/patricia-api.md) · [All operations](https://skmtc.dev/patricia/apis/patricia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/patricia/apis/patricia-api/revisions/0dfb44495ea1?raw)