TrulyInbox Open API

https://lupus-edge.trulyinbox.com/v1
Admin
The TrulyInbox Open API provides programmatic access to manage email accounts, control warmup...
Tokens:800
Snippets:11
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Fetch Email Accounts

Source: https://vertexaisearch.cloud.google.com/grounding-api-redirect/AUZIYQHC52IeONxesUnW9f6jLWIoPcQspCvLavu-IdE143e04HAUHohUhVvILZ_ZACQF99oFKm8yCsLQk93Fd7w6d-0mHGjKuN-og0ATByxNa6sd-VT3vRJIJD3Jvs5ZMK1ej3utvZP4qnJmf53TN6OQKytZ6dbXHvM=

Example using curl to fetch a list of email accounts. Replace YOUR_API_KEY with your actual API key.

```curl
curl -X GET "https://lupus-edge.trulyinbox.com/v1/email-accounts" \
  -H "X-Api-Key: YOUR_API_KEY"
```

--------------------------------

### Error Response Example

Source: https://vertexaisearch.cloud.google.com/grounding-api-redirect/AUZIYQHC52IeONxesUnW9f6jLWIoPcQspCvLavu-IdE143e04HAUHohUhVvILZ_ZACQF99oFKm8yCsLQk93Fd7w6d-0mHGjKuN-og0ATByxNa6sd-VT3vRJIJD3Jvs5ZMK1ej3utvZP4qnJmf53TN6OQKytZ6dbXHvM=

An example of an error response format from the API.

```json
{
  "error_code": "not_found",
  "message": "Email account not found.",
  "details": {}
}
```

--------------------------------

### Get Rate Limit Status

Source: https://vertexaisearch.cloud.google.com/grounding-api-redirect/AUZIYQHC52IeONxesUnW9f6jLWIoPcQspCvLavu-IdE143e04HAUHohUhVvILZ_ZACQF99oFKm8yCsLQk93Fd7w6d-0mHGjKuN-og0ATByxNa6sd-VT3vRJIJD3Jvs5ZMK1ej3utvZP4qnJmf53TN6OQKytZ6dbXHvM=

Checks the current rate limit status for your API key without consuming quota. This is useful for monitoring your API usage and avoiding rate limiting errors.

```APIDOC
## GET /v1/rate-limit

### Description
Retrieves the current rate limit status for your API key without consuming quota.

### Method
GET

### Endpoint
/v1/rate-limit

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **limit** (integer) - The total number of requests allowed per window.
- **remaining** (integer) - The number of requests remaining in the current window.
- **reset** (integer) - A Unix timestamp indicating when the rate limit window resets.

#### Response Example
{
  "limit": 20,
  "remaining": 18,
  "reset": 1678886400
}
```

--------------------------------

### API Base URL

Source: https://vertexaisearch.cloud.google.com/grounding-api-redirect/AUZIYQHC52IeONxesUnW9f6jLWIoPcQspCvLavu-IdE143e04HAUHohUhVvILZ_ZACQF99oFKm8yCsLQk93Fd7w6d-0mHGjKuN-og0ATByxNa6sd-VT3vRJIJD3Jvs5ZMK1ej3utvZP4qnJmf53TN6OQKytZ6dbXHvM=

The base URL for all API requests to the TrulyInbox Open API.

```text
https://lupus-edge.trulyinbox.com/v1
```

--------------------------------

### List Email Accounts

Source: https://vertexaisearch.cloud.google.com/grounding-api-redirect/AUZIYQHC52IeONxesUnW9f6jLWIoPcQspCvLavu-IdE143e04HAUHohUhVvILZ_ZACQF99oFKm8yCsLQk93Fd7w6d-0mHGjKuN-og0ATByxNa6sd-VT3vRJIJD3Jvs5ZMK1ej3utvZP4qnJmf53TN6OQKytZ6dbXHvM=

Retrieves a list of all connected email accounts. This is a foundational endpoint for managing your email accounts within the TrulyInbox system.

```APIDOC
## GET /v1/email-accounts

### Description
Retrieves a list of all connected email accounts.

### Method
GET

### Endpoint
/v1/email-accounts

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **accounts** (array) - A list of email account objects.

#### Response Example
{
  "accounts": [
    {
      "id": "account_id_1",
      "email": "user1@example.com",
      "status": "active",
      "warmup_enabled": true
    },
    {
      "id": "account_id_2",
      "email": "user2@example.com",
      "status": "inactive",
      "warmup_enabled": false
    }
  ]
}
```
Tokens:
Raw