# List invitations

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/setting/invite
```

- API version: v1
- Operation ID: `v1_public_invite_index`
- Section: Team settings › [Team invitations](https://developer.yoprint.com/reference/team-invitations.md)
- Web page: https://developer.yoprint.com/reference/team-invitations/v1-invite-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns the team's invitations that haven't been accepted yet, expired ones included (`expired: true`).

Each one shows the email, the permission group the person will get, and when it expires. The invitation link itself is never returned.

## Permission

Any member of the team, whatever their role. This is wider than the web app, whose Settings pages need Manage Settings: on the API only changes need it. AI apps (MCP connections) need Manage Settings to read it.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/invite' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `email` (string, required)
    - `expired` (boolean, required): True two months after the invitation was first created.
    - `expired_at` (string (date-time), required): When it expires: two months after it was created. Resending does not move this date.
    - `id` (string (uuid), required): The invitation's id: a UUID, not a hash id. Use it in the invitation paths.
    - `role` (object | null, optional): The permission group the person will join with. Null if that group was deleted since.
      - `id` (string, required)
      - `name` (string, required)
      - `permissions` (array of strings, required): The group's permission keys, as "Get a permission group" returns them.
      - `users` (array of objects, required): The members who already hold this group.
        - Each item:
          - `avatar_url` (string | null, required)
          - `email` (string, required)
          - `id` (string, required)
          - `name` (string, required)
      - `version` (integer, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "email": "jordan@example.com",
      "expired": false,
      "expired_at": "2027-01-03T09:00:00+00:00",
      "id": "0b5e8c1a-3f4d-4c2b-9a7e-1d2c3b4a5f60",
      "role": {
        "id": "drvVENtzY33bqP",
        "name": "Production",
        "permissions": [
          "view_all_order",
          "update_all_order"
        ],
        "users": [
          {
            "avatar_url": null,
            "email": "alex@example.com",
            "id": "E6LjYJJimQNFVF",
            "name": "Alex Rivera"
          }
        ],
        "version": 3
      }
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Notes

- Every invitation in this list, expired or not, counts toward your plan's user limit. Delete the ones you no longer need.

## Related

- [Invite someone to the team](https://developer.yoprint.com/reference/team-invitations/v1-invite-store.md): `POST /v1/api/store/{team_slug}/setting/invite`
- [Resend an invitation](https://developer.yoprint.com/reference/team-invitations/v1-team-invite-resend.md): `PATCH /v1/api/store/{team_slug}/setting/invite/resend/{invite}`
- [Delete an invitation](https://developer.yoprint.com/reference/team-invitations/v1-invite-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/invite/{invite}`