{"openapi":"3.1.0","info":{"title":"Zonka Feedback (BYOK) API","version":"0.1.0","description":"Zonka Feedback (BYOK) lets an AI assistant read your own Zonka Feedback data through the Zonka Feedback API with a key you supply (Zonka Feedback API auth token). Read-only: 9 tools (list_workspaces, list_surveys, get_survey, get_survey_snapshot, list_locations, get_location, list_devices, get_device, list_contact_segments). 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-zonka-feedback.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-zonka-feedback/docs"},"termsOfService":"https://connectorbay.com/byok-zonka-feedback/terms"},"servers":[{"url":"https://byok-zonka-feedback.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-zonka-feedback/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_workspaces":{"post":{"operationId":"list_workspaces","summary":"List the workspaces of the account. Use for \"Which workspaces do I have in Zonka Feedback\".","description":"List the workspaces of the account. Use for \"Which workspaces do I have in Zonka Feedback\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"}},"required":["region"],"title":"list_workspacesArguments","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_surveys":{"post":{"operationId":"list_surveys","summary":"List the surveys with status, workspace, locations and public survey links; filter by workspace. Use for \"Which Zonka Fe","description":"List the surveys with status, workspace, locations and public survey links; filter by workspace. Use for \"Which Zonka Feedback surveys are active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number (default 1).","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Records per page (default 25).","title":"Limit"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only surveys of this workspace id.","title":"Workspace Id"}},"required":["region"],"title":"list_surveysArguments","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_survey":{"post":{"operationId":"get_survey","summary":"Get one survey with its status, workspace, locations and public links. Use for \"What are the details of my Zonka Feedbac","description":"Get one survey with its status, workspace, locations and public links. Use for \"What are the details of my Zonka Feedback survey\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"},"survey_id":{"description":"Survey id (the id from list_surveys).","maxLength":200,"title":"Survey Id","type":"string"}},"required":["region","survey_id"],"title":"get_surveyArguments","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_survey_snapshot":{"post":{"operationId":"get_survey_snapshot","summary":"Get the response count, completion rate, average time and NPS, CSAT and CES scores of a survey for a date range (and opt","description":"Get the response count, completion rate, average time and NPS, CSAT and CES scores of a survey for a date range (and optionally one location). Use for \"What is the NPS of my Zonka Feedback survey this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"},"survey_id":{"description":"Survey id (the id from list_surveys).","maxLength":200,"title":"Survey Id","type":"string"},"start_date":{"description":"First day, YYYY-MM-DD.","maxLength":200,"title":"Start Date","type":"string"},"end_date":{"description":"Last day, YYYY-MM-DD.","maxLength":200,"title":"End Date","type":"string"},"location_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only responses from this location id.","title":"Location Id"}},"required":["region","survey_id","start_date","end_date"],"title":"get_survey_snapshotArguments","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_locations":{"post":{"operationId":"list_locations","summary":"List the locations (branches, stores, sites) with address, external id and labels. Use for \"Which locations are set up i","description":"List the locations (branches, stores, sites) with address, external id and labels. Use for \"Which locations are set up in Zonka Feedback\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number (default 1).","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Records per page (default 25).","title":"Limit"}},"required":["region"],"title":"list_locationsArguments","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_location":{"post":{"operationId":"get_location","summary":"Get one location with address, external id and labels. Use for \"What are the details of my Zonka Feedback location\".","description":"Get one location with address, external id and labels. Use for \"What are the details of my Zonka Feedback location\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"},"location_id":{"description":"Location id (the id from list_locations).","maxLength":200,"title":"Location Id","type":"string"}},"required":["region","location_id"],"title":"get_locationArguments","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_devices":{"post":{"operationId":"list_devices","summary":"List the feedback devices (kiosks, tablets) with status, app version, battery and last contact; no network addresses or ","description":"List the feedback devices (kiosks, tablets) with status, app version, battery and last contact; no network addresses or user names. Use for \"Which Zonka Feedback devices are offline\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number (default 1).","title":"Page"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Records per page (default 25).","title":"Limit"}},"required":["region"],"title":"list_devicesArguments","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_device":{"post":{"operationId":"get_device","summary":"Get one feedback device with status, app version, battery, location and last contact. Use for \"How is my Zonka Feedback ","description":"Get one feedback device with status, app version, battery, location and last contact. Use for \"How is my Zonka Feedback device doing\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"},"device_id":{"description":"Device id (the id from list_devices).","maxLength":200,"title":"Device Id","type":"string"}},"required":["region","device_id"],"title":"get_deviceArguments","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_segments":{"post":{"operationId":"list_contact_segments","summary":"List the contact segments (lists) with their type and size; the contacts themselves are not returned. Use for \"Which con","description":"List the contact segments (lists) with their type and size; the contacts themselves are not returned. Use for \"Which contact segments do I have in Zonka Feedback\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"region":{"description":"Datacenter of your Zonka Feedback account: us1 (United States), e (European Union), in (India) or au (Australia); shown next to the token under Company Settings, Developers, API.","enum":["us1","e","in","au"],"title":"Region","type":"string"}},"required":["region"],"title":"list_contact_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}}}}