---
title: "List email inboxes"
---

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

Path: Sureshake API › entities

`GET /v2/entities/{id}/email-inboxes`

## Path parameters

- `id` (`entity-list-email-inboxes.path.id`; string, required)
  - format `uuid`

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.sureshake.com/v2/entities/<id>/email-inboxes'
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/entities/<id>/email-inboxes';
const options = {method: 'GET'};

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

### Python

```python
import requests

url = "https://api.sureshake.com/v2/entities/<id>/email-inboxes"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
      "label": "string",
      "emailAddress": "user@example.com",
      "isActive": true,
      "processingRules": null,
      "autoForwardTo": [
        "string"
      ],
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "delivery": {
    "provider": "aws_ses",
    "domain": "string",
    "status": "ready",
    "reason": "string"
  }
}
```

- `data` (`entity-list-email-inboxes.response.200.data`; array<object>, required)
  - `id` (`entity-list-email-inboxes.response.200.data.id`; string, required)
    - format `uuid`
  - `entityId` (`entity-list-email-inboxes.response.200.data.entityId`; string, required)
    - format `uuid`
  - `label` (`entity-list-email-inboxes.response.200.data.label`; string, required)
    - minLength 1; maxLength 80
  - `emailAddress` (`entity-list-email-inboxes.response.200.data.emailAddress`; string, required)
    - format `email`
  - `isActive` (`entity-list-email-inboxes.response.200.data.isActive`; boolean, required)
  - `createdAt` (`entity-list-email-inboxes.response.200.data.createdAt`; any of, required)
    - any of: `string`, `string`
  - `updatedAt` (`entity-list-email-inboxes.response.200.data.updatedAt`; any of, required)
    - any of: `string`, `string`
  - `processingRules` (`entity-list-email-inboxes.response.200.data.processingRules`; unknown, optional, nullable)
  - `autoForwardTo` (`entity-list-email-inboxes.response.200.data.autoForwardTo`; array<string>, optional, nullable)
- `delivery` (`entity-list-email-inboxes.response.200.delivery`; object, required)
  - `provider` (`entity-list-email-inboxes.response.200.delivery.provider`; string, required)
    - one of `"aws_ses"`
  - `domain` (`entity-list-email-inboxes.response.200.delivery.domain`; string, required)
    - minLength 1
  - `status` (`entity-list-email-inboxes.response.200.delivery.status`; string, required)
    - one of `"ready"`, `"configuration_required"`
  - `reason` (`entity-list-email-inboxes.response.200.delivery.reason`; string, required, nullable)
    - minLength 1

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.400.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.401.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.403.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.404.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.409.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 422

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.422.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.422.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.422.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.422.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.422.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.429.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.500.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`entity-list-email-inboxes.response.503.error`; object, required)
  - `code` (`entity-list-email-inboxes.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`entity-list-email-inboxes.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`entity-list-email-inboxes.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`entity-list-email-inboxes.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/entity-list-email-inboxes/index.md