---
title: "listInvites"
---

> Documentation Index
> Fetch the complete documentation index at: https://agenthold.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# listInvites

Path: agenthold API › invites

`GET /workspaces/{workspaceId}/invites`

URL: `/api/v1/workspaces/{workspaceId}/invites`

## Authentication

Requires one of the following:

- `session`, apiKey, in cookie
- `token`, http bearer, header `Authorization`

## Path parameters

- `workspaceId` (`listInvites.path.workspaceId`; string, required)

## Code samples

### cURL

```bash
curl --request GET \
  --url '<base-url>/api/v1/workspaces/<workspaceId>/invites' \
  --cookie 'agenthold_session=<agenthold_session>'
```

### TypeScript

```typescript
const url = '<base-url>/api/v1/workspaces/<workspaceId>/invites';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "<base-url>/api/v1/workspaces/<workspaceId>/invites"

headers = {"cookie": "agenthold_session=<agenthold_session>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Pending invites.

#### Example

```json
[
  {
    "id": "string",
    "role": "admin",
    "email": "string",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z"
  }
]
```

- `id` (`listInvites.response.200.id`; string, required)
- `role` (`listInvites.response.200.role`; string, required)
  - one of `"admin"`, `"member"`
- `email` (`listInvites.response.200.email`; string, required)
- `createdBy` (`listInvites.response.200.createdBy`; string, required)
- `createdAt` (`listInvites.response.200.createdAt`; string, required)
  - format: `date-time`
- `expiresAt` (`listInvites.response.200.expiresAt`; string, required)
  - format: `date-time`

### 403

Error.

#### Example

```json
{
  "error": "string"
}
```

- `error` (`listInvites.response.403.error`; string, required)

### 404

Error.

#### Example

```json
{
  "error": "string"
}
```

- `error` (`listInvites.response.404.error`; string, required)


Source: https://agenthold.dev/api/list-invites/index.md