{"openapi":"3.1.0","info":{"title":"Zixflow (BYOK) API","version":"0.1.0","description":"Zixflow (BYOK) lets an AI assistant read your own Zixflow data through the Zixflow API with a key you supply (Zixflow API key). Read-only: 6 tools (list_collections, get_collection, list_lists, get_list, list_attributes, list_whatsapp_templates). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.zixflow.com....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-zixflow.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-zixflow/docs"},"termsOfService":"https://connectorbay.com/byok-zixflow/terms"},"servers":[{"url":"https://byok-zixflow.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-zixflow/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_collections":{"post":{"operationId":"list_collections","summary":"List the collections of your Zixflow workspace (system ones such as people, company and deals, and custom ones) with id,","description":"List the collections of your Zixflow workspace (system ones such as people, company and deals, and custom ones) with id, name, slug and type. Use for \"Which collections does my Zixflow workspace have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_collectionsArguments","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_collection":{"post":{"operationId":"get_collection","summary":"Get one Zixflow collection by id: name, slug and type. Use for \"What is Zixflow collection 652e506bf781c59be3825523\".","description":"Get one Zixflow collection by id: name, slug and type. Use for \"What is Zixflow collection 652e506bf781c59be3825523\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"collection_id":{"description":"Collection id from list_collections.","maxLength":200,"title":"Collection Id","type":"string"}},"required":["collection_id"],"title":"get_collectionArguments","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_lists":{"post":{"operationId":"list_lists","summary":"List the lists of your Zixflow workspace with id, name, slug, parent collection and whether duplicate records are allowe","description":"List the lists of your Zixflow workspace with id, name, slug, parent collection and whether duplicate records are allowed. Use for \"Which lists do I have in Zixflow\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_listsArguments","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_list":{"post":{"operationId":"get_list","summary":"Get one Zixflow list by id: name, slug, parent collection and duplicate setting. Use for \"What is Zixflow list 653bbba76","description":"Get one Zixflow list by id: name, slug, parent collection and duplicate setting. Use for \"What is Zixflow list 653bbba76ecd501e8dcbbb5d\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"list_id":{"description":"List id from list_lists.","maxLength":200,"title":"List Id","type":"string"}},"required":["list_id"],"title":"get_listArguments","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_attributes":{"post":{"operationId":"list_attributes","summary":"List the attributes (fields) of a Zixflow collection or list: name, API key name, input type, validation and whether eac","description":"List the attributes (fields) of a Zixflow collection or list: name, API key name, input type, validation and whether each is required, unique, archived or a system field. Use for \"What fields does my Zixflow people collection have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"target":{"description":"Whether the id is a collection or a list.","enum":["collection","list"],"title":"Target","type":"string"},"target_id":{"description":"Collection id or list id.","maxLength":200,"title":"Target Id","type":"string"}},"required":["target","target_id"],"title":"list_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}},"/v1/tools/list_whatsapp_templates":{"post":{"operationId":"list_whatsapp_templates","summary":"List the WhatsApp message templates of one connected Zixflow WhatsApp number: name, language, category, approval status ","description":"List the WhatsApp message templates of one connected Zixflow WhatsApp number: name, language, category, approval status and components. Use for \"Which approved WhatsApp templates do I have in Zixflow\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"phone_id":{"description":"WhatsApp phone id shown next to the number in the Zixflow WhatsApp settings.","maxLength":200,"title":"Phone Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"How many templates to return.","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"How many templates to skip.","title":"Offset"}},"required":["phone_id"],"title":"list_whatsapp_templatesArguments","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}}}}