---
displayed_sidebar: homepage
---

import ParameterTypes from "@site/src/components/ParameterTypes"

# AdminListInvitesRes

 **AdminListInvitesRes**: `Object`

The list of invites.

## Type declaration

<ParameterTypes parameters={[
  {
    "name": "invites",
    "type": "[Invite](../../entities/classes/entities.Invite.mdx)[]",
    "description": "An array of invites",
    "optional": false,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "accepted",
        "type": "`boolean`",
        "description": "Whether the invite was accepted or not.",
        "optional": false,
        "defaultValue": "false",
        "expandable": false,
        "children": []
      },
      {
        "name": "created_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was created.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "deleted_at",
        "type": "`null` \\| `Date`",
        "description": "The date with timezone at which the resource was deleted.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "expires_at",
        "type": "`Date`",
        "description": "The date the invite expires at.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "id",
        "type": "`string`",
        "description": "The invite's ID",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "metadata",
        "type": "`Record<string, unknown>`",
        "description": "An optional key-value map with additional details",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "role",
        "type": "[UserRoles](../../entities/enums/entities.UserRoles.mdx)",
        "description": "The user's role. These roles don't change the privileges of the user.",
        "optional": false,
        "defaultValue": "member",
        "expandable": false,
        "children": []
      },
      {
        "name": "token",
        "type": "`string`",
        "description": "The token used to accept the invite.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "updated_at",
        "type": "`Date`",
        "description": "The date with timezone at which the resource was updated.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "user_email",
        "type": "`string`",
        "description": "The email of the user being invited.",
        "optional": false,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />
