{"openapi":"3.1.0","info":{"title":"Rebrandly Scripts and Apps (BYOK) API","version":"0.1.0","description":"Rebrandly Scripts and Apps (BYOK) lets an AI assistant read your own Rebrandly Scripts and Apps data through the Rebrandly Scripts and Apps API with a key you supply (Rebrandly API key). Read-only: 8 tools (list_scripts, get_script, count_scripts, list_script_links, list_apps, get_app, list_app_links, list_custom_attributes). The BYOK key travels with each request, is used for that one call only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-rebrandly-scripts-apps.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-rebrandly-scripts-apps/docs"},"termsOfService":"https://connectorbay.com/byok-rebrandly-scripts-apps/terms"},"servers":[{"url":"https://byok-rebrandly-scripts-apps.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-rebrandly-scripts-apps/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_scripts":{"post":{"operationId":"list_scripts","summary":"List the tracking scripts (retargeting pixels) of the workspace with name and dates; the script code itself is left out.","description":"List the tracking scripts (retargeting pixels) of the workspace with name and dates; the script code itself is left out. Pages of up to 25; pass the last script id as last. Use for \"Which tracking pixels do I have set up in Rebrandly\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Field to sort by, default createdAt.","title":"Order By"},"order_dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (default) or desc.","title":"Order Dir"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"},"last":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"ID of the last item of the previous answer, to get the next page.","title":"Last"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only active scripts, false for the others.","title":"Active"}},"title":"list_scriptsArguments","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_script":{"post":{"operationId":"get_script","summary":"Get one tracking script by ID: name and creation and update dates (the script code is left out). Use for \"Show the detai","description":"Get one tracking script by ID: name and creation and update dates (the script code is left out). Use for \"Show the details of this Rebrandly tracking script\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"script_id":{"description":"Script ID (from list_scripts).","maxLength":64,"title":"Script Id","type":"string"}},"required":["script_id"],"title":"get_scriptArguments","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/count_scripts":{"post":{"operationId":"count_scripts","summary":"Count the tracking scripts of the workspace. Use for \"How many tracking scripts are in my Rebrandly workspace\".","description":"Count the tracking scripts of the workspace. Use for \"How many tracking scripts are in my Rebrandly workspace\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"count_scriptsArguments","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_script_links":{"post":{"operationId":"list_script_links","summary":"List the short links that have a given tracking script attached, with destination, domain and click count. Use for \"Whic","description":"List the short links that have a given tracking script attached, with destination, domain and click count. Use for \"Which Rebrandly links use this tracking pixel\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"script_id":{"description":"Script ID (from list_scripts).","maxLength":64,"title":"Script Id","type":"string"},"order_by":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Field to sort by, default createdAt.","title":"Order By"},"order_dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (default) or desc.","title":"Order Dir"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"},"last":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"ID of the last item of the previous answer, to get the next page.","title":"Last"}},"required":["script_id"],"title":"list_script_linksArguments","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_apps":{"post":{"operationId":"list_apps","summary":"List the deep-link apps registered in the workspace with name, scheme, type, install URL and fallback behaviour. Pages o","description":"List the deep-link apps registered in the workspace with name, scheme, type, install URL and fallback behaviour. Pages of up to 25. Use for \"Which mobile deep-link apps are set up in Rebrandly\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Field to sort by, default createdAt.","title":"Order By"},"order_dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (default) or desc.","title":"Order Dir"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"},"last":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"ID of the last item of the previous answer, to get the next page.","title":"Last"},"term":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only apps whose name matches this text.","title":"Term"}},"title":"list_appsArguments","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_app":{"post":{"operationId":"get_app","summary":"Get one deep-link app by ID with its scheme, install URL, path and fallback destination. Use for \"Show the details of th","description":"Get one deep-link app by ID with its scheme, install URL, path and fallback destination. Use for \"Show the details of this Rebrandly app\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"app_id":{"description":"App ID (from list_apps).","maxLength":64,"title":"App Id","type":"string"}},"required":["app_id"],"title":"get_appArguments","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_app_links":{"post":{"operationId":"list_app_links","summary":"List the short links that use a given deep-link app. Use for \"Which Rebrandly links open this app\".","description":"List the short links that use a given deep-link app. Use for \"Which Rebrandly links open this app\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"app_id":{"description":"App ID (from list_apps).","maxLength":64,"title":"App Id","type":"string"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"}},"required":["app_id"],"title":"list_app_linksArguments","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_custom_attributes":{"post":{"operationId":"list_custom_attributes","summary":"List the custom link attribute definitions of the workspace (key and value type). Use for \"Which custom attributes can I","description":"List the custom link attribute definitions of the workspace (key and value type). Use for \"Which custom attributes can I put on Rebrandly links\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"order_by":{"anyOf":[{"maxLength":50,"type":"string"},{"type":"null"}],"default":null,"description":"Field to sort by, default createdAt.","title":"Order By"},"order_dir":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc (default) or desc.","title":"Order Dir"},"limit":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many items to return (1 to 25, default 25).","title":"Limit"},"last":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"ID of the last item of the previous answer, to get the next page.","title":"Last"},"type":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Only attributes of this value type, for example string or number.","title":"Type"}},"title":"list_custom_attributesArguments","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}}}}