Skip to main content
GET
/
v1
/
invites
List Invites Handler
curl --request GET \
  --url http://localhost:8000/v1/invites
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email": "jsmith@example.com",
      "expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "invite_link": "<string>",
      "accepted_at": "2023-11-07T05:31:56Z",
      "email_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "total": 1,
  "limit": 2,
  "offset": 1
}

Headers

​
authorization
string | null

Query Parameters

​
email
string | null

Filter by email (case-insensitive partial match)

​
status
enum<string> | null
default:pending

Filter by invite status (pending, accepted, expired)

Available options:
pending,
accepted,
expired
​
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: x >= 0

Cookies

​
ks_uat
string | null

Response

Successful Response

​
items
InviteResponse · object[]
required

List of items

​
total
integer
required

Total number of items

Required range: x >= 0
​
limit
integer
required

Number of items per page

Required range: x >= 1
​
offset
integer
required

Number of items to skip

Required range: x >= 0