# Invite

> The Invite object in the Guv API.

## Fields

| Field | Type | Description |
| --- | --- | --- |
| `id` * | string |  |
| `email` * | string (email) or null |  |
| `waitlist_entry_id` * | string or null |  |
| `note` * | string |  |
| `status` * | `active`, `used`, `expired`, `revoked` |  |
| `code_hint` * | string |  |
| `created_at` * | string (date-time) |  |
| `expires_at` * | string (date-time) |  |
| `accepted_at` * | string (date-time) or null |  |
| `used_at` * | string (date-time) or null |  |
| `used_by_user_id` * | string or null |  |
| `revoked_at` * | string (date-time) or null |  |
| `created_by_user_id` * | string or null |  |

\* always present

## Example

```json
{
  "id": "sgi_01jbx2m9k7q4r8t5v6w3y0z1pr",
  "email": "ada@example.co.uk",
  "waitlist_entry_id": "wle_01jbx2m9k7q4r8t5v6w3y0z1pr",
  "note": "string",
  "status": "active",
  "code_hint": "string",
  "created_at": "2026-10-22T13:05:00Z",
  "expires_at": "2026-10-22T13:05:00Z",
  "accepted_at": "2026-10-22T13:05:00Z",
  "used_at": "2026-10-22T13:05:00Z",
  "used_by_user_id": "string",
  "revoked_at": "2026-10-22T13:05:00Z",
  "created_by_user_id": "string"
}
```

## Used by

- [Revoke a platform invitation](/docs/api/admin/#revoke-a-platform-invitation)