---
title: "List Invites"
slug: "list-invites"
updated: 2026-09-03T14:50:33Z
published: 2026-09-03T14:50:33Z
canonical: "developer.rocket.chat/list-invites"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# List Invites

Get/api/v1/listInvites

Lists all of the invites on the workspace.

[Permission](https://docs.rocket.chat/docs/permissions) required: `create-invite-links`

Responses200

OK

<select class='api-response-data' aria-label='Media type'><option value='89a4445c-9797-4df6-a24d-06ac4812d7cc'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='99cc3048-2148-4f87-a600-4a490d9fabc2'>Success</option>
</select>Success

```json
[
  {
    "_id": "kDKQ3H",
    "days": 1,
    "maxUses": 1,
    "rid": "s7CE842q9WtvLctD7",
    "userId": "sNiDqHit5nGAGFg8X",
    "createdAt": "2019-12-20T03:31:56.774Z",
    "expires": "2019-12-21T03:31:56.774Z",
    "uses": 1,
    "_updatedAt": "2019-12-20T03:33:40.065Z"
  },
  {
    "_id": "99ScEP",
    "days": 1,
    "maxUses": 0,
    "rid": "s7CE842q9WtvLctD7",
    "userId": "sNiDqHit5nGAGFg8X",
    "createdAt": "2019-12-20T03:38:20.485Z",
    "expires": "2019-12-21T03:38:20.485Z",
    "uses": 0,
    "_updatedAt": "2019-12-20T03:38:20.485Z"
  },
  {
    "_id": "Y5JKM4",
    "days": 0,
    "maxUses": 1,
    "rid": "s7CE842q9WtvLctD7",
    "userId": "sNiDqHit5nGAGFg8X",
    "createdAt": "2019-12-20T03:38:25.313Z",
    "expires": null,
    "uses": 1,
    "_updatedAt": "2019-12-20T03:38:40.116Z"
  }
]
```

Array of object   object  _idstring    
daysinteger    
maxUsesinteger    
ridstring    
userIdstring    
createdAtstring    
expiresstring   | null  
usesinteger    
_updatedAtstring    

401

Unauthorized

<select class='api-response-data' aria-label='Media type'><option value='cc2261cc-6d1e-47cd-9b6e-1e665caf3db4'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='3e1cf1b8-9d5a-44b0-868d-9cc0de9a6190'>Authorization Error</option>
</select>Authorization Error

```json
{
  "status": "error",
  "message": "You must be logged in to do this."
}
```

object  statusstring    
messagestring