Skip to content

Returns the paginated invitations the current user has issued for one space, newest first, with a ready-to-share access URL on each one that is still valid.

space_id is required — the space is loaded with findOrFail, so omitting it fails rather than returning every invitation. status defaults to pending; pass all to drop the status filter. The response also carries an is_mod flag for the client.

Endpoint

  • Method: GET

  • Path: /invitations

  • Edition: Core

  • Controller: InvitationController@getInvitations

  • Route source: fluent-community/Modules/Auth/InvitationModule.php:23

  • Controller source: fluent-community/Modules/Auth/Classes/InvitationController.php

  • Requires the community_moderator permission in the space named by space_id.

  • The query is always scoped to the caller own invitations, so a moderator does not see invitations issued by other moderators despite the is_mod flag suggesting otherwise.

  • Although the controller ships in the free plugin, the routes are only registered by FluentCommunity Pro and only while the invitation feature is enabled; otherwise they return 404.

  • This GET also writes: invitations past their expiry are flipped to expired and saved as the list is built.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET List Invitations

GET
/invitations

Returns the paginated invitations the current user has issued for one space, newest first, with a ready-to-share access URL on each one that is still valid.

Controller: InvitationController@getInvitations
Route source: fluent-community/Modules/Auth/InvitationModule.php:23

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type
API Key (header: Authorization)

Parameters

Query Parameters

space_id

Space ID read via $request->get() in getInvitations().

Type
string
status

Status read via $request->get() in getInvitations().

Type
string
Default
"pending"

Responses

Successful response

application/json
JSON
{
  
"invitations": {
  
  
"current_page": 0,
  
  
"data": [
  
  
  
{
  
  
  
  
"access_url": "string",
  
  
  
  
"created_at": "string",
  
  
  
  
"id": 0,
  
  
  
  
"message": "string",
  
  
  
  
"message_rendered": "string",
  
  
  
  
"meta": {
  
  
  
  
  
"invitee_name": "string"
  
  
  
  
},
  
  
  
  
"post_id": "string",
  
  
  
  
"reactions_count": "string",
  
  
  
  
"status": "string",
  
  
  
  
"type": "string",
  
  
  
  
"updated_at": "string",
  
  
  
  
"user_id": "string",
  
  
  
  
"xprofile": {
  
  
  
  
  
"avatar": "string",
  
  
  
  
  
"badge": "string",
  
  
  
  
  
"created_at": "string",
  
  
  
  
  
"display_name": "string",
  
  
  
  
  
"is_verified": 0,
  
  
  
  
  
"last_activity": "string",
  
  
  
  
  
"meta": {
  
  
  
  
  
  
"badge_slug": "string",
  
  
  
  
  
  
"cover_photo": "string",
  
  
  
  
  
  
"social_links": {
  
  
  
  
  
  
  
"fb": "string",
  
  
  
  
  
  
  
"instagram": "string",
  
  
  
  
  
  
  
"linkedin": "string",
  
  
  
  
  
  
  
"twitter": "string",
  
  
  
  
  
  
  
"youtube": "string"
  
  
  
  
  
  
},
  
  
  
  
  
  
"website": "string"
  
  
  
  
  
},
  
  
  
  
  
"permalink": "string",
  
  
  
  
  
"short_description": "string",
  
  
  
  
  
"status": "string",
  
  
  
  
  
"total_points": 0,
  
  
  
  
  
"user_id": 0,
  
  
  
  
  
"username": "string"
  
  
  
  
}
  
  
  
}
  
  
],
  
  
"first_page_url": "string",
  
  
"from": 0,
  
  
"last_page": 0,
  
  
"last_page_url": "string",
  
  
"links": [
  
  
  
{
  
  
  
  
"active": true,
  
  
  
  
"label": "string",
  
  
  
  
"url": "string"
  
  
  
}
  
  
],
  
  
"next_page_url": "string",
  
  
"path": "string",
  
  
"per_page": 0,
  
  
"prev_page_url": "string",
  
  
"to": 0,
  
  
"total": 0
  
},
  
"is_mod": true
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation