{"openapi":"3.1.0","info":{"title":"Benchmark Email (BYOK) API","version":"0.1.0","description":"Benchmark Email (BYOK) lets an AI assistant read your own Benchmark Email data through the Benchmark Email API with a key you supply (API token). Read-only: 12 tools (list_contact_lists, get_contact_list, get_contact_list_summary, list_contact_list_fields, list_list_segments, get_active_contact_count, get_unique_contact_count, list_email_reports, get_email_report, list_automations,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-benchmarkemail.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-benchmarkemail/docs"},"termsOfService":"https://connectorbay.com/byok-benchmarkemail/terms"},"servers":[{"url":"https://byok-benchmarkemail.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-benchmarkemail/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_contact_lists":{"post":{"operationId":"list_contact_lists","summary":"List the account's contact lists with ID, name, description, contact count and dates. Wrapped in Response.Data; page wit","description":"List the account's contact lists with ID, name, description, contact count and dates. Wrapped in Response.Data; page with page_number and page_size (max 100). Use for \"Which contact lists do I have in Benchmark Email and how big are they\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many rows per page (1 to 100).","title":"Page Size"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Sort Order"},"search_filter":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only lists whose name contains this text.","title":"Search Filter"}},"title":"list_contact_listsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_contact_list":{"post":{"operationId":"get_contact_list","summary":"Get one contact list: name, description, active contact count, creation date and the labels used for first, middle and l","description":"Get one contact list: name, description, active contact count, creation date and the labels used for first, middle and last name. Use for \"Show the details of my Benchmark Email list 15242968\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"list_id":{"description":"ID of the contact list, as returned by list_contact_lists (digits, for example '15242968').","maxLength":200,"title":"List Id","type":"string"}},"required":["list_id"],"title":"get_contact_listArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_contact_list_summary":{"post":{"operationId":"get_contact_list_summary","summary":"Get the contact counts of one list by state: active, bounced (hard and soft), unsubscribed and not yet opted in. Use for","description":"Get the contact counts of one list by state: active, bounced (hard and soft), unsubscribed and not yet opted in. Use for \"How many contacts in list 15242968 unsubscribed or bounced\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"list_id":{"description":"ID of the contact list, as returned by list_contact_lists (digits, for example '15242968').","maxLength":200,"title":"List Id","type":"string"}},"required":["list_id"],"title":"get_contact_list_summaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_contact_list_fields":{"post":{"operationId":"list_contact_list_fields","summary":"List the field names (columns) a contact list stores, such as email, firstname and custom fields. Use for \"Which fields ","description":"List the field names (columns) a contact list stores, such as email, firstname and custom fields. Use for \"Which fields does my Benchmark Email list 15242968 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"list_id":{"description":"ID of the contact list, as returned by list_contact_lists (digits, for example '15242968').","maxLength":200,"title":"List Id","type":"string"}},"required":["list_id"],"title":"list_contact_list_fieldsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_list_segments":{"post":{"operationId":"list_list_segments","summary":"List the segments defined on one contact list with ID, name and contact count. Use for \"What segments exist on my Benchm","description":"List the segments defined on one contact list with ID, name and contact count. Use for \"What segments exist on my Benchmark Email list 15242968\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"list_id":{"description":"ID of the contact list, as returned by list_contact_lists (digits, for example '15242968').","maxLength":200,"title":"List Id","type":"string"}},"required":["list_id"],"title":"list_list_segmentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_active_contact_count":{"post":{"operationId":"get_active_contact_count","summary":"Get the total number of active contacts across the whole account. Use for \"How many active contacts does my Benchmark Em","description":"Get the total number of active contacts across the whole account. Use for \"How many active contacts does my Benchmark Email account have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_active_contact_countArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_unique_contact_count":{"post":{"operationId":"get_unique_contact_count","summary":"Get the number of unique contacts (each email address once) across all lists of the account. Use for \"How many unique em","description":"Get the number of unique contacts (each email address once) across all lists of the account. Use for \"How many unique email addresses are in my Benchmark Email lists\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_unique_contact_countArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_email_reports":{"post":{"operationId":"list_email_reports","summary":"List email campaigns with send results: sent, opens, unopened, clicks, bounces, unsubscribes and the lists they went to.","description":"List email campaigns with send results: sent, opens, unopened, clicks, bounces, unsubscribes and the lists they went to. Use for \"How did my latest Benchmark Email campaigns perform\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many rows per page (1 to 100).","title":"Page Size"},"filter":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only campaigns whose name contains this text.","title":"Filter"}},"title":"list_email_reportsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_email_report":{"post":{"operationId":"get_email_report","summary":"Get the result summary of one email campaign: sent, opens, clicks, bounces, unsubscribes, complaints, forwards, subject ","description":"Get the result summary of one email campaign: sent, opens, clicks, bounces, unsubscribes, complaints, forwards, subject and schedule. Use for \"What were the open and click numbers of Benchmark Email campaign 12496233\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"email_id":{"description":"ID of the email campaign, as returned by list_email_reports (digits, for example '12496233').","maxLength":200,"title":"Email Id","type":"string"}},"required":["email_id"],"title":"get_email_reportArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_automations":{"post":{"operationId":"list_automations","summary":"List automations (autoresponder series) with name, status, list, contact count and last change. Use for \"Which Benchmark","description":"List automations (autoresponder series) with name, status, list, contact count and last change. Use for \"Which Benchmark Email automations do I have and are they active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many rows per page (1 to 100).","title":"Page Size"},"filter":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only automations whose name contains this text.","title":"Filter"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Sort Order"}},"title":"list_automationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_automation_report":{"post":{"operationId":"get_automation_report","summary":"Get the per-email results of one automation: sends, opens, clicks, bounces, unsubscribes and the delay in days of each s","description":"Get the per-email results of one automation: sends, opens, clicks, bounces, unsubscribes and the delay in days of each step. Use for \"How is the Benchmark Email automation 91626 performing step by step\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"automation_id":{"description":"ID of the automation, as returned by list_automations (digits).","maxLength":200,"title":"Automation Id","type":"string"}},"required":["automation_id"],"title":"get_automation_reportArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_plan_usage":{"post":{"operationId":"get_plan_usage","summary":"Get the account's plan name, email sending allowance used, expiry and contact usage. Billing and card details are not re","description":"Get the account's plan name, email sending allowance used, expiry and contact usage. Billing and card details are not returned. Use for \"How much of my Benchmark Email plan have I used\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_plan_usageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}