> For the complete documentation index, see [llms.txt](https://kevins-organization-58.gitbook.io/smtp-ghost-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kevins-organization-58.gitbook.io/smtp-ghost-api/authentication.md).

# Authentication

All API calls require a valid API key in the `X-KEY` header.

### Base URL

`https://smtpghost.com/api/v1/`

* The host is `smtpghost.com`
* All requests should be made with HTTPS
* All of our endpoints accept the POST method only

### Obtaining Your API Key

1. Sign in to your SMTPGhost dashboard.
2. Navigate to **My Account → API Settings**.
3. Copy your **API Key**.

### Request Header

{% hint style="info" %}
You are required to add the header Content-Type: application/json
{% endhint %}

| Header         | Value                         | Required |
| -------------- | ----------------------------- | :------: |
| `Content-Type` | `application/json`            |    Yes   |
| `X-KEY`        | `<your-organization-api-key>` |    Yes   |

### Example

```bash
curl -X POST https://smtpghost.com/api/v1/linkedin_finder \
  -H "Content-Type: application/json" \
  -H "X-KEY: EhMYEvKukPHppaynAMzExQ8i" \
  -d '{
    "linkedin_url": "https://www.linkedin.com/in/urrutia/"
  }'

```

### Success Response (HTTP 200)

```json

{
  "status": "success",
  "linkedin_url": "https://www.linkedin.com/in/urrutia/",
  "email_address": "kevin@voymedia.com",
  "email_status": "VALID",
  "account_type": "professional",
  "is_catch_all": false,
  "profile": {
    "linkedin_url": "...",
    "input_url": "...",
    "name": "Kevin Urrutia",
    // …other profile fields…
    "updated_at": "2025-05-16T12:10:46.874-04:00"
  }
}
```
