---
title: "Listar convites"
method: GET
path: "/v1/api/invites"
---

# Listar convites

`GET /v1/api/invites`

## Request

- Base URL: `https://api.nuvidio.com`
- URL: `https://api.nuvidio.com/v1/api/invites`
- Auth: none required

Retorna a lista de convites já gerados.

## Query parameters

- `take` integer
- `page` integer
- `search` string

## Response `200`

200

- object
  - `invites` object[]
    - `id` string
    - `title` string
    - `start` string
    - `expiration` string
    - `used` boolean
    - `usedAt` string[]
    - `customerData` object[]
      - `_id` string
      - `value` string
      - `label` string
    - `token` string
    - `type` string
    - `canceled` boolean
    - `accessed` boolean
    - `calls` string[]
    - `createdAt` string
    - `isEnabled` boolean
  - `count` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `89c4a530a05e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nuvidio/apis/nuvidio-openapi/changes/v1/api/invites/get.md)

---

[API](https://skmtc.dev/nuvidio/apis/nuvidio-openapi.md) - [All operations](https://skmtc.dev/nuvidio/apis/nuvidio-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/nuvidio/apis/nuvidio-openapi/revisions/89c4a530a05e?raw)