---
title: "List invitations to a project"
method: GET
path: "/projects/{project_id}/invitations"
tags: ["Project Invitations"]
---

# List invitations to a project

`GET /projects/{project_id}/invitations`

Returns a list of invitations to a project.

## Query parameters

- `filter[state]` StringFilter
  - `eq` string — Equal
  - `ne` string — Not equal
  - `in` string — In (comma-separated list)
  - `nin` string — Not in (comma-separated list)
  - `between` string — Between (comma-separated list)
  - `contains` string — Contains
  - `starts` string — Starts with
  - `ends` string — Ends with
- `page[size]` integer
- `page[before]` string
- `page[after]` string
- `sort` 'updated_at' | '-updated_at'

## Response `200`

OK

- ProjectInvitation[]
  - `id` string, uuid — The ID of the invitation.
  - `state` 'pending' | 'processing' | 'accepted' | 'cancelled' | 'error' — The invitation state.
  - `project_id` string — The ID of the project.
  - `role` 'admin' | 'viewer' — The project role.
  - `email` string, email — The email address of the invitee.
  - `owner` object — The inviter.
    - `id` string, uuid — The ID of the user.
    - `display_name` string — The user's display name.
  - `created_at` string, date-time — The date and time when the invitation was created.
  - `updated_at` string, date-time — The date and time when the invitation was last updated.
  - `finished_at` string, date-time, nullable — The date and time when the invitation was finished.
  - `environments` object[]
    - `id` string — The ID of the environment.
    - `type` string — The environment type.
    - `role` 'admin' | 'viewer' | 'contributor' — The environment role.
    - `title` string — The environment title.

## Other responses

- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/upsun/apis/upsun-com-rest-api.md) · [All operations](https://skmtc.net/upsun/apis/upsun-com-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/upsun/upsun-com-rest-api/revisions/6cc88fde6435/schema)