---
title: "List User Invites"
method: GET
path: "/v2/facts/{proj_id}/{env_id}/user_invites"
tags: ["User Invites"]
---

# List User Invites

`GET /v2/facts/{proj_id}/{env_id}/user_invites`

## Path parameters

- `proj_id` string, required — Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
- `env_id` string, required — Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

## Query parameters

- `role` string — optional role filter, will only return invited users with this role.
- `tenant` string — optional tenant filter, will only return invited users in that tenant.
- `search` string — optional search, will only return invited users to that email, key or name.
- `page` integer — Page number of the results to fetch, starting at 1.
- `per_page` integer — The number of results per page (max 100).

## Response `200`

Successful Response

- PaginatedResultElementsUserInviteRead
  - `data` ElementsUserInviteRead[], required — List of Elements User Invites
    - `id` string, uuid, required — Unique id of the elements_user_invite
    - `organization_id` string, uuid, required — Unique id of the organization that the elements_user_invite belongs to.
    - `project_id` string, uuid, required — Unique id of the project that the elements_user_invite belongs to.
    - `environment_id` string, uuid, required — Unique id of the environment that the elements_user_invite belongs to.
    - `created_at` string, date-time, required — Date and time when the elements_user_invite was created (ISO_8601 format).
    - `updated_at` string, date-time, required — Date and time when the elements_user_invite was last updated/modified (ISO_8601 format).
    - `key` string, required — The key of the user that is being invited
    - `status` 'pending' | 'approved', required — An enumeration.
    - `email` string, email, required — The email of the user that being invited
    - `first_name` string, required — The first name of the user that is being invited
    - `last_name` string, required — The last name of the user that is being invited
    - `role_id` string, uuid, required — The role of the user that is being invited
    - `tenant_id` string, uuid, required — The tenant id of the user that is being invited
    - `resource_instance_id` string, uuid, required — The resource instance id of the user that is being invited
  - `total_count` integer, required
  - `page_count` integer

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/permit/apis/permit-io-api.md) · [All operations](https://skmtc.dev/permit/apis/permit-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/permit/permit-io-api/revisions/13faa12b4692/schema)