Eden

Eden Customers API

The Customers API from Eden — 6 operation(s) for customers.

GitHub OpenAPI

Operations 7

GET /store-app/v1/customers/find Find a customer by email #
POST /store-app/v1/customers/remove-access Remove access #
POST /store-app/v1/customers/access-email Send the access email again #
POST /store-app/v1/customers/cohort Move a buyer into a cohort #
GET /store-app/v1/customers List customers #
POST /store-app/v1/customers Give someone free access #
GET /store-app/v1/customers/{email} Get one customer #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/eden-so/openapi/eden-so-customers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/eden-so:eden-so-customers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

eden-so-customers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Eden store Customers API
  version: 1.0.0
  summary: Sales, customers, products, communities, email list, and webhooks for an Eden store.
  description: 'Record sales from any checkout, give and remove access, list every sale and customer, make and publish products, post in your communities, manage the store''s email list, and get events by webhook.


    **Sign in:** `Authorization: Bearer `, an Eden API key from Settings → API with Full access, or Custom with Store on Edit (Store on Read can only make GET calls). A key reaches one store, picked when it''s made. Store calls need Starter or above.


    **Lists** take `limit` (1 to 100), `starting_after` (the last page''s `next_cursor`), `created_after`, and `created_before`, and answer `{ ok, data, has_more, next_cursor }`.


    Your workspace (Discover, scheduling, boards, notes, Custom AIs) is a separate spec: https://mcp.eden.so/v1/openapi.json'
  contact:
    name: Eden
    url: https://eden.so/help/api/api-reference/
  termsOfService: https://eden.so/terms/
servers:
- url: https://api.eden.so
  description: Eden store API
security:
- apiKey: []
tags:
- name: Customers
paths:
  /store-app/v1/customers/find:
    get:
      operationId: getCustomersFind
      summary: Find a customer by email
      description: An empty `customers` list means no match.
      tags:
      - Customers
      parameters:
      - name: email
        in: query
        required: true
        schema:
          minLength: 1
          maxLength: 320
          type: string
      - name: product
        in: query
        required: false
        schema:
          maxLength: 240
          type: string
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
  /store-app/v1/customers/remove-access:
    post:
      operationId: postCustomersRemoveAccess
      summary: Remove access
      description: An Eden checkout membership also stops billing.
      tags:
      - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - product
              - email
              properties:
                product:
                  minLength: 1
                  maxLength: 240
                  type: string
                email:
                  minLength: 3
                  maxLength: 320
                  type: string
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
  /store-app/v1/customers/access-email:
    post:
      operationId: postCustomersAccessEmail
      summary: Send the access email again
      description: One per person per minute.
      tags:
      - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - product
              - email
              properties:
                product:
                  minLength: 1
                  maxLength: 240
                  type: string
                email:
                  minLength: 3
                  maxLength: 320
                  type: string
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
  /store-app/v1/customers/cohort:
    post:
      operationId: postCustomersCohort
      summary: Move a buyer into a cohort
      tags:
      - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - product
              - email
              - cohort
              properties:
                product:
                  minLength: 1
                  maxLength: 240
                  type: string
                email:
                  minLength: 3
                  maxLength: 320
                  type: string
                cohort:
                  minLength: 1
                  maxLength: 240
                  type: string
                over_cap:
                  type: boolean
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
  /store-app/v1/customers:
    get:
      operationId: getCustomers
      summary: List customers
      description: 'One row a person, newest first, paged. Filters: `product`, `has_access`, `tag`.'
      tags:
      - Customers
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - maxLength: 4
            type: string
          - type: number
      - name: starting_after
        in: query
        required: false
        schema:
          maxLength: 600
          type: string
      - name: created_after
        in: query
        required: false
        schema:
          anyOf:
          - maxLength: 64
            type: string
          - type: number
      - name: created_before
        in: query
        required: false
        schema:
          anyOf:
          - maxLength: 64
            type: string
          - type: number
      - name: product
        in: query
        required: false
        schema:
          maxLength: 240
          type: string
      - name: has_access
        in: query
        required: false
        schema:
          maxLength: 8
          type: string
      - name: tag
        in: query
        required: false
        schema:
          maxLength: 240
          type: string
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
    post:
      operationId: postCustomers
      summary: Give someone free access
      description: Adds them to a live product without counting a sale.
      tags:
      - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - product
              - email
              properties:
                product:
                  minLength: 1
                  maxLength: 240
                  type: string
                email:
                  minLength: 3
                  maxLength: 320
                  type: string
                name:
                  maxLength: 160
                  type: string
                send_email:
                  type: boolean
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
  /store-app/v1/customers/{email}:
    get:
      operationId: getCustomersEmail
      summary: Get one customer
      tags:
      - Customers
      parameters:
      - name: email
        in: path
        required: true
        schema:
          minLength: 3
          maxLength: 400
          type: string
      responses:
        '200':
          description: 'Done. Most answers carry `ok: true`.'
          content:
            application/json:
              schema:
                type: object
        '400':
          $ref: '#/components/responses/Failure'
        '401':
          $ref: '#/components/responses/Failure'
        '402':
          $ref: '#/components/responses/Failure'
        '403':
          $ref: '#/components/responses/Failure'
        '404':
          $ref: '#/components/responses/Failure'
        '409':
          $ref: '#/components/responses/Failure'
        '422':
          $ref: '#/components/responses/Failure'
        '429':
          $ref: '#/components/responses/Failure'
        '500':
          $ref: '#/components/responses/Failure'
components:
  schemas:
    Failure:
      type: object
      required:
      - ok
      - error
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: string
          description: A machine code, like `product_not_found`.
        message:
          type: string
  responses:
    Failure:
      description: The call failed. `error` and `message` say why.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Failure'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: eden_pat_…
      description: An Eden API key from Settings → API, or the Zapier app's OAuth token.