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

# Check subscription

> Check if an email is subscribed to the newsletter.

## Request

```http theme={null}
GET /newsletter/check?email=test@example.com
x-shop-id: {{shopId}}
```

## Headers

| Header      | Type   | Description        |
| ----------- | ------ | ------------------ |
| `x-shop-id` | string | Identify the shop. |

## Query parameters

| Parameter | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| `email`   | string | Yes      | Email address to check. |

## Successful response

```json theme={null}
{
    "status": 200,
    "success": true,
    "message": "Subscription status retrieved",
    "data": {
        "isSubscribed": true,
        "exists": true
    }
}
```

## Not subscribed response

```json theme={null}
{
    "status": 200,
    "success": true,
    "message": "Subscription status retrieved",
    "data": {
        "isSubscribed": false,
        "exists": false
    }
}
```


## OpenAPI

````yaml GET /newsletter/check
openapi: 3.1.0
info:
  title: Salesive Store API
  description: >-
    REST interface for querying products, categories, and merchandising banners
    exposed by Salesive storefronts.
  version: 1.0.0
servers:
  - description: Production
    url: https://store.salesive.com/api/v1
security:
  - BearerAuth: []
    ShopIdHeader: []
paths:
  /newsletter/check:
    get:
      summary: Check subscription
      description: Check if an email is subscribed.
      parameters:
        - $ref: '#/components/parameters/XShopIdHeader'
        - name: email
          in: query
          required: true
          schema:
            type: string
            format: email
      responses:
        '200':
          description: Subscription status retrieved
components:
  parameters:
    XShopIdHeader:
      name: x-shop-id
      in: header
      description: >-
        Optional identifier that scopes responses to a specific storefront when
        the referer cannot be inferred.
      required: false
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT issued by the Salesive Store API for authenticated shoppers.
    ShopIdHeader:
      type: apiKey
      in: header
      name: x-shop-id
      description: >-
        Optional storefront identifier sent as a header to scope responses to a
        specific shop. Try It requests remember this value once provided.

````