{"openapi":"3.1.0","info":{"title":"Systeme.io (BYOK) API","version":"0.1.0","description":"Systeme.io (BYOK) lets an AI assistant read your own Systeme.io data through the Systeme.io API with a key you supply (public API key). Read-only: 10 tools (list_funnels, list_funnel_steps, list_email_campaigns, list_newsletters, list_contact_fields, list_courses, list_digital_products, list_price_plans, list_coupons, list_domains). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-systeme.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-systeme/docs"},"termsOfService":"https://connectorbay.com/byok-systeme/terms"},"servers":[{"url":"https://byok-systeme.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-systeme/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_funnels":{"post":{"operationId":"list_funnels","summary":"List sales funnels with id, name, active flag and linked sale settings id. Cursor-paged (10 to 100 per page). Use for \"W","description":"List sales funnels with id, name, active flag and linked sale settings id. Cursor-paged (10 to 100 per page). Use for \"What funnels do I have in Systeme.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to search for in names.","title":"Query"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"title":"list_funnelsArguments","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_funnel_steps":{"post":{"operationId":"list_funnel_steps","summary":"List the steps (pages) of one funnel with type, position, page id, URL and linked offer id. Use for \"What steps does fun","description":"List the steps (pages) of one funnel with type, position, page id, URL and linked offer id. Use for \"What steps does funnel 123 have in Systeme.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"funnel_id":{"description":"Numeric funnel id (see list_funnels).","minimum":1,"title":"Funnel Id","type":"integer"},"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to search for in names.","title":"Query"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"required":["funnel_id"],"title":"list_funnel_stepsArguments","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_campaigns":{"post":{"operationId":"list_email_campaigns","summary":"List email campaigns (automated sequences) with id, name and sender email. Use for \"Which email campaigns exist in Syste","description":"List email campaigns (automated sequences) with id, name and sender email. Use for \"Which email campaigns exist in Systeme.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to search for in names.","title":"Query"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"title":"list_email_campaignsArguments","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_newsletters":{"post":{"operationId":"list_newsletters","summary":"List newsletters (broadcasts) with id, type, subject, preview text, sender and whether it was sent. Use for \"What newsle","description":"List newsletters (broadcasts) with id, type, subject, preview text, sender and whether it was sent. Use for \"What newsletters have I created in Systeme.io and were they sent\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to search for in names.","title":"Query"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"title":"list_newslettersArguments","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_fields":{"post":{"operationId":"list_contact_fields","summary":"List the contact fields defined in the account (slug and display name). Use for \"Which contact fields can I use in Syste","description":"List the contact fields defined in the account (slug and display name). Use for \"Which contact fields can I use in Systeme.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_contact_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_courses":{"post":{"operationId":"list_courses","summary":"List school courses with name, description, domain, path and active flag, optionally only active ones. Use for \"Which co","description":"List school courses with name, description, domain, path and active flag, optionally only active ones. Use for \"Which courses do I offer through Systeme.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for active courses only, false for inactive only; omit for all.","title":"Active"},"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to search for in names.","title":"Query"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"title":"list_coursesArguments","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_digital_products":{"post":{"operationId":"list_digital_products","summary":"List digital products with name, origin (digital-store, funnel or Whitelabel), creation time and number of price plans a","description":"List digital products with name, origin (digital-store, funnel or Whitelabel), creation time and number of price plans and resources. Use for \"What digital products do I sell with Systeme.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"source":{"anyOf":[{"enum":["digital-store","funnel","Whitelabel"],"type":"string"},{"type":"null"}],"default":null,"description":"Origin of the product: digital-store, funnel or Whitelabel.","title":"Source"},"currency":{"anyOf":[{"maxLength":3,"type":"string"},{"type":"null"}],"default":null,"description":"Three-letter lowercase currency code of an attached price plan, for example usd or eur.","title":"Currency"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"title":"list_digital_productsArguments","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_price_plans":{"post":{"operationId":"list_price_plans","summary":"List price plans with name, type, amount, currency and category. Use for \"What price plans are set up in Systeme.io\".","description":"List price plans with name, type, amount, currency and category. Use for \"What price plans are set up in Systeme.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to search for in names.","title":"Query"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"title":"list_price_plansArguments","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_coupons":{"post":{"operationId":"list_coupons","summary":"List discount coupons with code, discount amount and type, currency, expiry, use limit and active flag. Use for \"Which d","description":"List discount coupons with code, discount amount and type, currency, expiry, use limit and active flag. Use for \"Which discount coupons are active in Systeme.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Text to search for in names.","title":"Query"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"title":"list_couponsArguments","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_domains":{"post":{"operationId":"list_domains","summary":"List the domains connected to the account with name, status and type, optionally only those usable right now. Use for \"W","description":"List the domains connected to the account with name, status and type, optionally only those usable right now. Use for \"Which domains are connected to my Systeme.io account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Case-insensitive partial match on the domain name.","title":"Query"},"workable_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only active or deactivated (usable) domains.","title":"Workable Only"},"limit":{"anyOf":[{"maximum":100,"minimum":10,"type":"integer"},{"type":"null"}],"default":20,"description":"How many items to return (10 to 100).","title":"Limit"},"starting_after":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Cursor for the next page: the id of the last item received. Leave empty for the first page; use it only while hasMore is true.","title":"Starting After"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Order by id: asc or desc.","title":"Order"}},"title":"list_domainsArguments","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}}}}