---
title: "List invites"
method: GET
path: "/v1/businesses/{client_id}/invites"
tags: ["Invites"]
---

# List invites

`GET /v1/businesses/{client_id}/invites`

Returns a paginated list of invites for the given business. Includes both pending and accepted invites; excludes cancelled invites.

## Path parameters

- `client_id` integer, required

## Query parameters

- `offset` integer
- `limit` integer

## Response `200`

OK

- InviteListResponse
  - `count` integer — The total number of invites that match the query.
  - `next` string, nullable — The URL to the next page of invites.
  - `previous` string, nullable — The URL to the previous page of invites.
  - `results` Invite[]
    - `id` integer — The ID of the invite.
    - `email` string, email — The email address the invite was sent to.
    - `role_id` string, uuid — The ID of the role assigned to the invitee.
    - `role` string — The name of the role assigned to the invitee.
    - `payment_types` PaymentType[] — The payment types the invitee will have access to.
    - `used` boolean — Whether the invite has been accepted.
    - `created` string, date-time — The date and time the invite was created in UTC.
    - `updated` string, date-time — The date and time the invite was last updated in UTC.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/letsweel/apis/weel-openapi.md) · [All operations](https://skmtc.net/letsweel/apis/weel-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/letsweel/weel-openapi/revisions/55da5fa350fb/schema)
