---
title: "Get a list of federation invites"
method: GET
path: "/ocs/v2.php/apps/spreed/api/{apiVersion}/federation/invitation"
tags: ["federation"]
---

# Get a list of federation invites

`GET /ocs/v2.php/apps/spreed/api/{apiVersion}/federation/invitation`

🚧 Draft: Still work in progress

## Path parameters

- `apiVersion` 'v1', required

## Headers

- `OCS-APIRequest` boolean, required

## Response `200`

Get list of received federation invites successfully

- object
  - `ocs` object, required
    - `meta` OCSMeta, required
      - `status` string, required
      - `statuscode` integer, required
      - `message` string
      - `totalitems` string
      - `itemsperpage` string
    - `data` FederationInvite[], required
      - `id` integer, required — Identifier of the invitation
      - `state` integer, required — State of the invitation
      - `localCloudId` string, required — Cloud ID of the local user
      - `localToken` string, required — Token of the local conversation
      - `remoteAttendeeId` integer, required — Attendee ID on the remote server
      - `remoteServerUrl` string, required — URL of the remote server
      - `remoteToken` string, required — Token on the remote server
      - `roomName` string, required — Name of the conversation on the remote server
      - `userId` string, required — User id of the invited user
      - `inviterCloudId` string, required — Cloud ID of the inviter
      - `inviterDisplayName` string, required — Display name of the inviter

## Other responses

- `401` — Current user is not logged in

---

[API](https://skmtc.dev/nextcloud/apis/spreed-full.md) · [All operations](https://skmtc.dev/nextcloud/apis/spreed-full/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nextcloud/spreed-full/revisions/41d6458d6d6e/schema)