# getColleagueInvitationAvailability

Source: /openapi/thomas-federated.openapi.json

## Operation

| Method | URL |
|---|---|
| GET | https://cxi-api-prod-weu-interim-eraffmdbdmdmbdfz.a01.azurefd.net/v1/colleagues/invitation-availability |

| Field | Value |
|---|---|
| operationId | getColleagueInvitationAvailability |
| method | GET |
| server | https://cxi-api-prod-weu-interim-eraffmdbdmdmbdfz.a01.azurefd.net/v1 |
| path | /colleagues/invitation-availability |
| tags | `Colleagues & Profiles` |
| summary | Read whether new colleague invitations are paused |
| badges | `{"name":"Admin"}`, `{"name":"Owner"}` |

## Request Parameters

None.

## Request Body

None.

## Responses

| Status | Description | Schema refs |
|---|---|---|
| 200 | Whether stored seat enforcement currently blocks new invitations. `false` means no stored block; it does not guarantee an invitation will succeed. | #/components/schemas/InvitationAvailabilityResponseDto |
| 401 | Invalid or missing authentication token (AUTH_TOKEN_INVALID) | #/components/schemas/ApiErrorResponseDto |
| 403 | An organisation admin or owner is required | #/components/schemas/ApiErrorResponseDto |
| 500 | The organisation read failed — availability is unknown | #/components/schemas/ApiErrorResponseDto |
| 503 | Invitation availability is unknown | #/components/schemas/ApiErrorResponseDto |

## Artifact Examples

### Response 401 example

```json
{
  "statusCode": 401,
  "message": "Invalid or missing authentication token",
  "error": "AUTH_TOKEN_INVALID"
}
```

### Response 403 example

```json
{
  "statusCode": 403,
  "message": "Insufficient role privileges",
  "error": "AUTH_INSUFFICIENT_ROLE"
}
```