---
title: "List invitations"
method: GET
path: "/api/invitations"
tags: ["Invitation"]
---

# List invitations

`GET /api/invitations`

Retrieve a paginated list of invitations for the organisation with optional filtering by search term and status.

## Query parameters

- `search` string
- `status` 'pending' | 'accepted'
- `page` number
- `perPage` number

## Response `200`

Paginated list of invitations

- object — Paginated list of invitations
  - `results` object[], required — List of invitations
    - `id` string, uuid, required — Unique identifier of the invitation
    - `email` string, email, required — Email address the invitation was sent to
    - `expiresAt` string, nullable, required — Expiration date of the invitation
    - `createdAt` string, required — Timestamp when the invitation was created
    - `acceptedAt` string, nullable, required — Timestamp when the invitation was accepted
    - `status` 'pending' | 'accepted', required — Current status of the invitation
    - `createdBy` object, nullable — User who created the invitation
      - `id` string, uuid, required — Unique identifier of the user
      - `email` string, email, required — Email address of the user
      - `firstName` string, nullable, required — First name of the user
      - `lastName` string, nullable, required — Last name of the user
      - `type` 'invited' | 'member' | 'author' | 'admin' | 'owner', required — Type of user (e.g., admin, member)
      - `status` 'active' | 'disabled' | 'locked', required — Current status of the user
    - `user` object, nullable — User the invitation is for
      - `id` string, uuid, required — Unique identifier of the user
      - `email` string, email, required — Email address of the user
      - `firstName` string, nullable, required — First name of the user
      - `lastName` string, nullable, required — Last name of the user
      - `type` 'invited' | 'member' | 'author' | 'admin' | 'owner', required — Type of user (e.g., admin, member)
      - `status` 'active' | 'disabled' | 'locked', required — Current status of the user
    - `organisation` object, nullable — Organisation the invitation belongs to
      - `id` string, uuid, required — Unique identifier of the organisation
      - `name` string, required — Name of the organisation
  - `paginate` object, required — Pagination metadata
    - `current` number, required — Current page number
    - `from` number, required — Starting record number on the current page
    - `to` number, required — Ending record number on the current page
    - `total` number, required — Total number of records
    - `pageSize` number, required — Number of records per page

---

[API](https://skmtc.dev/gorules/apis/gorules-agent-api.md) · [All operations](https://skmtc.dev/gorules/apis/gorules-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gorules/gorules-agent-api/revisions/52c0773fcd80/schema)