---
title: "List Invites"
method: GET
path: "/invites"
tags: ["Invites"]
---

# List Invites

`GET /invites`

List the list of invites sent out to users.

## Query parameters

- `size` integer
- `cursor` string

## Response `200`

OK

- InviteListResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` object
    - `nextCursor` string — The next cursor value that can be used in the following query.
    - `items` Invite[]
      - `id` string, required — Unique ID of this object
      - `createdAt` string, date-time, required — Date and time
      - `fullName` string, required — The full name of the invited user
      - `firstName` string — The first name of the invited user
      - `lastName` string — The last name of the invited user
      - `email` string, email, required — The email address of the invited user
      - `templateId` string, required — The template ID used in the invitation
      - `winkTemplateId` string — The Wink template ID used in the invitation
      - `userId` string, required — The user ID for this invitation
      - `status` 'INVITED' | 'EMAIL_OPENED' | 'LANDING_PAGE_OPENED' | 'WINK_WIDGET_OPENED' | 'LINKED' | 'REVOKED', required — Status of the invite
      - `updatedAt` string, date-time, required — Date and time
      - `invitedAt` string, date-time, required — Date and time
      - `linkedAt` string, date-time, required — Date and time
      - `inviteLandingPageUrl` string — URL of the unique landing page for the invited user to connect their accounts

---

[API](https://skmtc.net/smileapi/apis/smile-api.md) · [All operations](https://skmtc.net/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smileapi/smile-api/versions/d1e0cb5dc33c/schema)