---
title: "List user invitations"
description: "List all invitations granting access to the Charitips dashboard"
canonical: https://www.charitips.com/docs/api-reference/list-user-invitations
---

# List user invitations

`GET /v1/user-invitations`

List all invitations granting access to the Charitips dashboard

**Authentication**: Bearer access token.

## Parameters

- `limit` (number, integer, minimum 1, maximum 100): The max number of items to return.
- `cursor` (string, UUID): The id of the last item from the previous page. Used to fetch the next page.
- `status` (string): Filter on invitation status One of `PENDING`, `CLAIMED`, `CANCELED`.
- `accountId` (string, UUID): Id of the account. Only useful for Platform customers to filter invitations by child accounts.

## Response 200

- `userInvitationId` (string, required)
- `firstName` (string, required)
- `lastName` (string, required)
- `email` (string, required)
- `phone` (string)
- `slug` (string, required)
- `status` (UserInvitationStatus, required) One of `PENDING`, `CLAIMED`, `CANCELED`.
- `role` (Role, required) One of `ADMIN`, `MEMBER`, `PAYROLL_MANAGER`.
- `accountId` (string, required)
- `createdAt` (string (date-time), required)
- `updatedAt` (string (date-time), required)

## Errors

- 400 `A field is missing, has the wrong type, or is not part of the request schema.`: `message` lists every problem. Unknown fields are rejected, not ignored: remove them rather than sending extra data. See https://www.charitips.com/docs/api-reference/errors.md.
- 401 `Unauthorized`: The access token is missing, expired or invalid. Create a new one with your client id and secret, send it as `Authorization: Bearer <accessToken>`, then retry once. Sandbox tokens only work on api.sandbox.charitips.com. See https://www.charitips.com/docs/get-started/authentication.md.
- 403 `Account closed`: The account behind these credentials is closed: no token is issued and every call is refused, reads included. Contact Charitips to reopen it. See https://www.charitips.com/docs/api-reference/troubleshooting.md#calls-answer-403-account-not-active-account-not-validated-or-account-closed.

## Example

```bash
curl -X GET https://api.sandbox.charitips.com/v1/user-invitations \
  -H "Authorization: Bearer $CHARITIPS_TOKEN"
```

```javascript
const response = await fetch('https://api.sandbox.charitips.com/v1/user-invitations', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.CHARITIPS_TOKEN}`,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const data = await response.json();
```

```python
import os, requests

response = requests.get(
    "https://api.sandbox.charitips.com/v1/user-invitations",
    headers={"Authorization": f"Bearer {os.environ['CHARITIPS_TOKEN']}"},
)
response.raise_for_status()
data = response.json()
```

## Response example (200, placeholder values)

```json
[
  {
    "userInvitationId": "<userInvitationId>",
    "firstName": "<firstName>",
    "lastName": "<lastName>",
    "email": "<email>",
    "phone": "<phone>",
    "slug": "<slug>",
    "status": "PENDING",
    "role": "ADMIN"
  }
]
```