{"openapi":"3.1.0","info":{"title":"Uniqode (BYOK) API","version":"0.1.0","description":"Uniqode (BYOK) lets an AI assistant read your own Uniqode data through the Uniqode API with a key you supply (Uniqode API key (Pro or Core plan and above)). Read-only: 12 tools (list_qr_codes, get_qr_code, list_organizations, get_organization_counts, get_scan_count, get_unique_scanner_count, get_scans_over_time, get_top_qr_codes, get_scans_by_country, get_scans_by_device_os, get_period_overview,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-uniqode.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-uniqode/docs"},"termsOfService":"https://connectorbay.com/byok-uniqode/terms"},"servers":[{"url":"https://byok-uniqode.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-uniqode/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_qr_codes":{"post":{"operationId":"list_qr_codes","summary":"List QR codes in the account, optionally filtered by a text in the name or by QR type. Paged by the provider. Use for \"W","description":"List QR codes in the account, optionally filtered by a text in the name or by QR type. Paged by the provider. Use for \"Which QR codes do I have in Uniqode\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name__icontains":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only QR codes whose name contains this text.","title":"Name  Icontains"},"qr_type":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only this QR type (see the provider docs for the numeric or named types).","title":"Qr Type"},"organization":{"anyOf":[{"maximum":99999999999,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only QR codes of this organization id.","title":"Organization"}},"title":"list_qr_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/get_qr_code":{"post":{"operationId":"get_qr_code","summary":"Get the details of one QR code by its numeric id. Use for \"Show Uniqode QR code 67137\".","description":"Get the details of one QR code by its numeric id. Use for \"Show Uniqode QR code 67137\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"qr_id":{"description":"Numeric QR code id (from list_qr_codes).","title":"Qr Id","type":"integer"}},"required":["qr_id"],"title":"get_qr_codeArguments","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_organizations":{"post":{"operationId":"list_organizations","summary":"List the organizations (and child organizations) linked to the account, with their ids. Use for \"Which Uniqode organizat","description":"List the organizations (and child organizations) linked to the account, with their ids. Use for \"Which Uniqode organizations does my key reach\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_organizationsArguments","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_organization_counts":{"post":{"operationId":"get_organization_counts","summary":"Get the counts of QR codes, cards and other objects that belong to an organization. Use for \"How many QR codes does my U","description":"Get the counts of QR codes, cards and other objects that belong to an organization. Use for \"How many QR codes does my Uniqode organization hold\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"}},"required":["org_id"],"title":"get_organization_countsArguments","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_scan_count":{"post":{"operationId":"get_scan_count","summary":"Total number of QR code scans in a time window (all QR codes of the organization). Use for \"How many QR code scans did w","description":"Total number of QR code scans in a time window (all QR codes of the organization). Use for \"How many QR code scans did we get between these dates in Uniqode\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"},"from_timestamp":{"description":"Start of the window as epoch milliseconds.","maximum":99999999999999,"minimum":0,"title":"From Timestamp","type":"integer"},"to_timestamp":{"description":"End of the window as epoch milliseconds; must be later than from_timestamp.","maximum":99999999999999,"minimum":0,"title":"To Timestamp","type":"integer"},"hide_anomalies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True leaves out scans flagged as bot or abusive traffic.","title":"Hide Anomalies"}},"required":["org_id","from_timestamp","to_timestamp"],"title":"get_scan_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_scanner_count":{"post":{"operationId":"get_unique_scanner_count","summary":"Number of distinct people who scanned a QR code in a window, de-duplicated across the whole window. Use for \"How many un","description":"Number of distinct people who scanned a QR code in a window, de-duplicated across the whole window. Use for \"How many unique scanners did our QR codes have in Uniqode\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"},"from_timestamp":{"description":"Start of the window as epoch milliseconds.","maximum":99999999999999,"minimum":0,"title":"From Timestamp","type":"integer"},"to_timestamp":{"description":"End of the window as epoch milliseconds; must be later than from_timestamp.","maximum":99999999999999,"minimum":0,"title":"To Timestamp","type":"integer"},"hide_anomalies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True leaves out scans flagged as bot or abusive traffic.","title":"Hide Anomalies"}},"required":["org_id","from_timestamp","to_timestamp"],"title":"get_unique_scanner_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_scans_over_time":{"post":{"operationId":"get_scans_over_time","summary":"Scans bucketed into a zero-filled time series (default one bucket per day). Use for \"Show our Uniqode QR scans per day\".","description":"Scans bucketed into a zero-filled time series (default one bucket per day). Use for \"Show our Uniqode QR scans per day\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"},"from_timestamp":{"description":"Start of the window as epoch milliseconds.","maximum":99999999999999,"minimum":0,"title":"From Timestamp","type":"integer"},"to_timestamp":{"description":"End of the window as epoch milliseconds; must be later than from_timestamp.","maximum":99999999999999,"minimum":0,"title":"To Timestamp","type":"integer"},"hide_anomalies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True leaves out scans flagged as bot or abusive traffic.","title":"Hide Anomalies"},"interval":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":"1d","description":"Bucket size such as 1h or 1d.","title":"Interval"},"timezone":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":"UTC","description":"IANA timezone used to align time buckets, for example 'America/New_York'.","title":"Timezone"}},"required":["org_id","from_timestamp","to_timestamp"],"title":"get_scans_over_timeArguments","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_top_qr_codes":{"post":{"operationId":"get_top_qr_codes","summary":"Leaderboard of QR codes by scan count in a window (highest first, 1 to 100 codes). Use for \"Which of our QR codes were s","description":"Leaderboard of QR codes by scan count in a window (highest first, 1 to 100 codes). Use for \"Which of our QR codes were scanned most in Uniqode\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"},"from_timestamp":{"description":"Start of the window as epoch milliseconds.","maximum":99999999999999,"minimum":0,"title":"From Timestamp","type":"integer"},"to_timestamp":{"description":"End of the window as epoch milliseconds; must be later than from_timestamp.","maximum":99999999999999,"minimum":0,"title":"To Timestamp","type":"integer"},"hide_anomalies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True leaves out scans flagged as bot or abusive traffic.","title":"Hide Anomalies"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":5,"description":"How many QR codes to return (1 to 100).","title":"Limit"}},"required":["org_id","from_timestamp","to_timestamp"],"title":"get_top_qr_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/get_scans_by_country":{"post":{"operationId":"get_scans_by_country","summary":"Scan counts grouped by country for a window. Use for \"In which countries are our Uniqode QR codes scanned\".","description":"Scan counts grouped by country for a window. Use for \"In which countries are our Uniqode QR codes scanned\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"},"from_timestamp":{"description":"Start of the window as epoch milliseconds.","maximum":99999999999999,"minimum":0,"title":"From Timestamp","type":"integer"},"to_timestamp":{"description":"End of the window as epoch milliseconds; must be later than from_timestamp.","maximum":99999999999999,"minimum":0,"title":"To Timestamp","type":"integer"},"hide_anomalies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True leaves out scans flagged as bot or abusive traffic.","title":"Hide Anomalies"}},"required":["org_id","from_timestamp","to_timestamp"],"title":"get_scans_by_countryArguments","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_scans_by_device_os":{"post":{"operationId":"get_scans_by_device_os","summary":"Scan counts and share per device operating system (iPhone, android, iPad OS, windows, mac, Other). Use for \"Which phone ","description":"Scan counts and share per device operating system (iPhone, android, iPad OS, windows, mac, Other). Use for \"Which phone platforms scan our Uniqode QR codes\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"},"from_timestamp":{"description":"Start of the window as epoch milliseconds.","maximum":99999999999999,"minimum":0,"title":"From Timestamp","type":"integer"},"to_timestamp":{"description":"End of the window as epoch milliseconds; must be later than from_timestamp.","maximum":99999999999999,"minimum":0,"title":"To Timestamp","type":"integer"},"hide_anomalies":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"description":"True leaves out scans flagged as bot or abusive traffic.","title":"Hide Anomalies"}},"required":["org_id","from_timestamp","to_timestamp"],"title":"get_scans_by_device_osArguments","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_period_overview":{"post":{"operationId":"get_period_overview","summary":"Summary tiles for a window: total scans, QR codes scanned and total active dynamic QR codes. Use for \"Give me an overvie","description":"Summary tiles for a window: total scans, QR codes scanned and total active dynamic QR codes. Use for \"Give me an overview of our Uniqode QR activity\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"},"from_timestamp":{"description":"Start of the window as epoch milliseconds.","maximum":99999999999999,"minimum":0,"title":"From Timestamp","type":"integer"},"to_timestamp":{"description":"End of the window as epoch milliseconds; must be later than from_timestamp.","maximum":99999999999999,"minimum":0,"title":"To Timestamp","type":"integer"}},"required":["org_id","from_timestamp","to_timestamp"],"title":"get_period_overviewArguments","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_anomalous_scan_count":{"post":{"operationId":"get_anomalous_scan_count","summary":"Number of scans in a window that were flagged as bot or abusive traffic. Use for \"How many Uniqode QR scans looked like ","description":"Number of scans in a window that were flagged as bot or abusive traffic. Use for \"How many Uniqode QR scans looked like bot traffic\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"org_id":{"description":"Numeric Uniqode organization id (shown with the API key on the dashboard API page, or in list_organizations).","title":"Org Id","type":"integer"},"from_timestamp":{"description":"Start of the window as epoch milliseconds.","maximum":99999999999999,"minimum":0,"title":"From Timestamp","type":"integer"},"to_timestamp":{"description":"End of the window as epoch milliseconds; must be later than from_timestamp.","maximum":99999999999999,"minimum":0,"title":"To Timestamp","type":"integer"}},"required":["org_id","from_timestamp","to_timestamp"],"title":"get_anomalous_scan_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}}}}