Benchmark Email

Benchmark Email Lists API

List related endpoints

GitHub OpenAPI

Operations 9

DELETE /api/contact-structure/{contactStructureId}/lists Delete multiple lists #
GET /api/contact-structure/{contactStructureId}/lists Get paginated lists #
POST /api/contact-structure/{contactStructureId}/lists Create a new list #
GET /api/contact-structure/{contactStructureId}/lists/all Get all lists #
POST /api/contact-structure/{contactStructureId}/lists/merge Merge lists into a new list. #
DELETE /api/contact-structure/{contactStructureId}/lists/{listId} Delete a list by id #
GET /api/contact-structure/{contactStructureId}/lists/{listId} Get a list by id #
PATCH /api/contact-structure/{contactStructureId}/lists/{listId} Update a list by id #
POST /api/contact-structure/{contactStructureId}/lists/{listId}/duplicate Duplicate a list #

Documentation

📖
Documentation
https://developers.benchmarkemail.io/
📖
APIReference
https://developers.benchmarkemail.io/api-reference
📖
GettingStarted
https://developers.benchmarkemail.io/introduction
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/authentication/benchmark-email-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/rate-limits/benchmark-email-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/openapi/benchmark-email-lists-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/scopes/benchmark-email-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/errors/benchmark-email-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/conventions/benchmark-email-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/data-model/benchmark-email-data-model.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/mcp/benchmark-email-tool-crosswalk.yml
🔗
AgentCard
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/a2a/benchmark-email-a2a.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/llms/benchmark-email-llms.txt

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/benchmark-email-lists-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

benchmark-email-lists-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: 'Public REST API for Benchmark Email.


    Authenticate every request by including your API key in the `X-API-Key` header.

    Each key is issued with one or more scopes that control which endpoints it may call.


    Rate limits: 60 requests per minute per account.

    Monthly quota: determined by your subscription plan.'
  title: Benchmark Email Lists API
  version: 1.0.0
servers:
- description: Your account's API base URL. Copy the full URL shown on Settings > API Keys in your Benchmark Email account and paste it here.
  url: '{apiBaseUrl}'
  variables:
    apiBaseUrl:
      default: ''
      description: Your account's API base URL. Copy it from Settings > API Keys in your Benchmark Email account.
security:
- apiKeyAuth: []
tags:
- description: List related endpoints
  name: lists
paths:
  /api/contact-structure/{contactStructureId}/lists:
    delete:
      operationId: delete_api_contact_structure_by_contactStructureId_lists
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '204':
          description: Successfully deleted
        '400':
          description: Invalid request
      security:
      - apiKeyAuth: []
      summary: Delete multiple lists
      tags:
      - lists
      x-api-key-scope: contacts:write
    get:
      operationId: get_api_contact_structure_by_contactStructureId_lists
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      - description: page number
        in: query
        name: page
        schema:
          minimum: 1
          type: integer
      - description: page size
        in: query
        name: size
        schema:
          minimum: 1
          type: integer
      - description: 'Sorting parameter with the format ''field:direction''. Supported fields: name, createdAt, updatedAt.'
        examples:
          ascSort:
            summary: ascending sort by name
            value: name:asc
          descSort:
            summary: descending sort by createdAt
            value: createdAt:desc
        in: query
        name: sort
        required: false
        schema:
          pattern: ^[a-zA-Z0-9_]+:(asc|desc)$
          type: string
      - description: A string used to filter the search results. The maximum length is 50 characters.
        in: query
        name: criteria
        schema:
          maxLength: 50
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  properties:
                    __v:
                      type: number
                    _id:
                      type: string
                    createdAt:
                      type: string
                    name:
                      type: string
                    totalCampaigns:
                      type: number
                    totalContacts:
                      type: number
                    type:
                      type: string
                    updatedAt:
                      type: string
                  type: object
                type: array
          description: Successful
      security:
      - apiKeyAuth: []
      summary: Get paginated lists
      tags:
      - lists
      x-api-key-scope: contacts:read
    post:
      operationId: post_api_contact_structure_by_contactStructureId_lists
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '201':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  createdAt:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                  updatedAt:
                    type: string
                type: object
          description: Successfully created
        '400':
          description: Invalid request
      security:
      - apiKeyAuth: []
      summary: Create a new list
      tags:
      - lists
      x-api-key-scope: contacts:write
  /api/contact-structure/{contactStructureId}/lists/all:
    get:
      operationId: get_api_contact_structure_by_contactStructureId_lists_all
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  properties:
                    _id:
                      type: string
                    name:
                      type: string
                    type:
                      type: string
                  type: object
                type: array
          description: Successful
      security:
      - apiKeyAuth: []
      summary: Get all lists
      tags:
      - lists
      x-api-key-scope: contacts:read
  /api/contact-structure/{contactStructureId}/lists/merge:
    post:
      operationId: post_api_contact_structure_by_contactStructureId_lists_merge
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  createdAt:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                  updatedAt:
                    type: string
                type: object
          description: Successfully merged lists
        '400':
          description: Invalid request
      security:
      - apiKeyAuth: []
      summary: Merge lists into a new list.
      tags:
      - lists
      x-api-key-scope: contacts:write
  /api/contact-structure/{contactStructureId}/lists/{listId}:
    delete:
      operationId: delete_api_contact_structure_by_contactStructureId_lists_by_listId
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      - in: path
        name: listId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successfully deleted
        '400':
          description: Invalid request
      security:
      - apiKeyAuth: []
      summary: Delete a list by id
      tags:
      - lists
      x-api-key-scope: contacts:write
    get:
      operationId: get_api_contact_structure_by_contactStructureId_lists_by_listId
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      - in: path
        name: listId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  createdAt:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                  updatedAt:
                    type: string
                type: object
          description: Successful
        '400':
          description: Invalid request
      security:
      - apiKeyAuth: []
      summary: Get a list by id
      tags:
      - lists
      x-api-key-scope: contacts:read
    patch:
      operationId: patch_api_contact_structure_by_contactStructureId_lists_by_listId
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      - in: path
        name: listId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  createdAt:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                  updatedAt:
                    type: string
                type: object
          description: Successfully updated
        '400':
          description: Invalid request
      security:
      - apiKeyAuth: []
      summary: Update a list by id
      tags:
      - lists
      x-api-key-scope: contacts:write
  /api/contact-structure/{contactStructureId}/lists/{listId}/duplicate:
    post:
      operationId: post_api_contact_structure_by_contactStructureId_lists_by_listId_duplicate
      parameters:
      - in: path
        name: contactStructureId
        required: true
        schema:
          format: mongo-id
          type: string
      - in: path
        name: listId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json: {}
      responses:
        '201':
          content:
            application/json:
              schema:
                properties:
                  __v:
                    type: number
                  _id:
                    type: string
                  createdAt:
                    type: string
                  name:
                    type: string
                  type:
                    type: string
                  updatedAt:
                    type: string
                type: object
          description: Successfully duplicated
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
      security:
      - apiKeyAuth: []
      summary: Duplicate a list
      tags:
      - lists
      x-api-key-scope: contacts:write
components:
  securitySchemes:
    apiKeyAuth:
      description: API key authentication
      in: header
      name: X-API-Key
      type: apiKey