{"openapi":"3.1.0","info":{"title":"Partnerize (BYOK) API","version":"0.1.0","description":"Partnerize (BYOK) lets an AI assistant read your own Partnerize data through the Partnerize API with a key you supply (Partnerize user application key). Read-only: 11 tools (list_networks, list_brands, list_campaigns, get_campaign, list_campaign_partners, list_creatives, list_deals, list_voucher_codes, list_commission_groups, list_commissions, list_invoices). The BYOK key travels with each...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-partnerize.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-partnerize/docs"},"termsOfService":"https://connectorbay.com/byok-partnerize/terms"},"servers":[{"url":"https://byok-partnerize.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-partnerize/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_networks":{"post":{"operationId":"list_networks","summary":"List the Partnerize networks your user has access to. Use for \"Which Partnerize networks can I access\".","description":"List the Partnerize networks your user has access to. Use for \"Which Partnerize networks can I access\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_networksArguments","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_brands":{"post":{"operationId":"list_brands","summary":"List the brand accounts (advertisers) your user manages, with status and currency. Contact details are left out. Use for","description":"List the brand accounts (advertisers) your user manages, with status and currency. Contact details are left out. Use for \"Which brands do I manage in Partnerize\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":300,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum results per page.","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Number of results to skip.","title":"Offset"}},"title":"list_brandsArguments","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_campaigns":{"post":{"operationId":"list_campaigns","summary":"List the campaigns (partnership programs) your user can see, with brand, currency, conversion type and cookie period. Us","description":"List the campaigns (partnership programs) your user can see, with brand, currency, conversion type and cookie period. Use for \"Which Partnerize campaigns do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"network_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only campaigns in this network id (from list_networks).","title":"Network Id"}},"title":"list_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/get_campaign":{"post":{"operationId":"get_campaign","summary":"Get one campaign with its tracking settings, cookie period, approval options and status. Use for \"Show settings of Partn","description":"Get one campaign with its tracking settings, cookie period, approval options and status. Use for \"Show settings of Partnerize campaign 10l176\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"campaign_id":{"description":"Campaign id from list_campaigns.","maxLength":40,"title":"Campaign Id","type":"string"}},"required":["campaign_id"],"title":"get_campaignArguments","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_campaign_partners":{"post":{"operationId":"list_campaign_partners","summary":"List the partners (publishers) participating in a campaign with status, country, promotional method and vertical. Contac","description":"List the partners (publishers) participating in a campaign with status, country, promotional method and vertical. Contact details are left out. Use for \"Which partners are in Partnerize campaign 10l176\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"campaign_id":{"description":"Campaign id from list_campaigns.","maxLength":40,"title":"Campaign Id","type":"string"}},"required":["campaign_id"],"title":"list_campaign_partnersArguments","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_creatives":{"post":{"operationId":"list_creatives","summary":"List the campaign's creatives (banners, text links, HTML) with size, destination and tracking link. Use for \"Which creat","description":"List the campaign's creatives (banners, text links, HTML) with size, destination and tracking link. Use for \"Which creatives does Partnerize campaign 10l176 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"campaign_id":{"description":"Campaign id from list_campaigns.","maxLength":40,"title":"Campaign Id","type":"string"}},"required":["campaign_id"],"title":"list_creativesArguments","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_deals":{"post":{"operationId":"list_deals","summary":"List the campaign's deals and offers shown to partners, with coupon code, offer value and validity dates. Use for \"What ","description":"List the campaign's deals and offers shown to partners, with coupon code, offer value and validity dates. Use for \"What deals does Partnerize campaign 10l176 run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"campaign_id":{"description":"Campaign id from list_campaigns.","maxLength":40,"title":"Campaign Id","type":"string"}},"required":["campaign_id"],"title":"list_dealsArguments","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_voucher_codes":{"post":{"operationId":"list_voucher_codes","summary":"List the campaign's voucher codes used for coupon tracking, with validity dates and the commission groups they map to. U","description":"List the campaign's voucher codes used for coupon tracking, with validity dates and the commission groups they map to. Use for \"Which voucher codes exist for Partnerize campaign 10l176\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"campaign_id":{"description":"Campaign id from list_campaigns.","maxLength":40,"title":"Campaign Id","type":"string"}},"required":["campaign_id"],"title":"list_voucher_codesArguments","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_commission_groups":{"post":{"operationId":"list_commission_groups","summary":"List the campaign's partner commission groups with validity dates and the partner ids in each. Use for \"Which commission","description":"List the campaign's partner commission groups with validity dates and the partner ids in each. Use for \"Which commission groups does Partnerize campaign 10l176 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"campaign_id":{"description":"Campaign id from list_campaigns.","maxLength":40,"title":"Campaign Id","type":"string"}},"required":["campaign_id"],"title":"list_commission_groupsArguments","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_commissions":{"post":{"operationId":"list_commissions","summary":"List the campaign's commission structures (v2) with rates, performance model, cookie period and status. Use for \"What co","description":"List the campaign's commission structures (v2) with rates, performance model, cookie period and status. Use for \"What commission rates does Partnerize campaign 10l176 pay\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"campaign_id":{"description":"Campaign id from list_campaigns.","maxLength":40,"title":"Campaign Id","type":"string"},"at":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Date and time to show active commissions for, ISO 8601; defaults to now.","title":"At"}},"required":["campaign_id"],"title":"list_commissionsArguments","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_invoices":{"post":{"operationId":"list_invoices","summary":"List a brand's invoices to partners with campaign, period, net and total values, VAT and payment status. Use for \"Show i","description":"List a brand's invoices to partners with campaign, period, net and total values, VAT and payment status. Use for \"Show invoices for Partnerize brand 10l110\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"advertiser_id":{"description":"Brand id from list_brands.","maxLength":40,"title":"Advertiser Id","type":"string"}},"required":["advertiser_id"],"title":"list_invoicesArguments","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}}}}