{"openapi":"3.1.0","info":{"title":"Courier (BYOK) API","version":"0.1.0","description":"Courier (BYOK) lets an AI assistant read your own Courier data through the Courier API with a key you supply (API key). Read-only: 7 tools (list_messages, get_message, list_lists, list_brands, list_notification_templates, list_tenants, list_audit_events). 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...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-courier.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-courier/docs"},"termsOfService":"https://connectorbay.com/byok-courier/terms"},"servers":[{"url":"https://byok-courier.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-courier/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_messages":{"post":{"operationId":"list_messages","summary":"List notification messages sent through Courier with status (for example DELIVERED, OPENED, UNDELIVERABLE), recipient, n","description":"List notification messages sent through Courier with status (for example DELIVERED, OPENED, UNDELIVERABLE), recipient, notification and timestamps in epoch milliseconds. Cursor pagination. Use for \"Which Courier notifications were undeliverable recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: pass paging.cursor from the previous answer to get the next page.","title":"Cursor"},"recipient":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages to this recipient ID.","title":"Recipient"},"notification":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages sent with this notification ID.","title":"Notification"},"list":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages sent to this list ID.","title":"List"},"message_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only the message with this ID returned by a send.","title":"Message Id"},"tenant_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only messages sent in this tenant's context.","title":"Tenant Id"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to include archived messages.","title":"Archived"}},"title":"list_messagesArguments","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_message":{"post":{"operationId":"get_message","summary":"Get one message by ID: status, recipient, notification, error and reason, timestamps in epoch milliseconds and per-provi","description":"Get one message by ID: status, recipient, notification, error and reason, timestamps in epoch milliseconds and per-provider delivery detail. Use for \"What happened to this Courier message\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"message_id":{"description":"Message ID from list_messages or from a send.","maxLength":200,"title":"Message Id","type":"string"}},"required":["message_id"],"title":"get_messageArguments","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 subscriber lists with ID, name and timestamps, optionally filtered by ID pattern (* matches one part, ** a trailing","description":"List subscriber lists with ID, name and timestamps, optionally filtered by ID pattern (* matches one part, ** a trailing wildcard). Use for \"What lists do I have in Courier\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: pass paging.cursor from the previous answer to get the next page.","title":"Cursor"},"pattern":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Exact list ID, or a pattern such as 'newsletter.*'.","title":"Pattern"}},"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/list_brands":{"post":{"operationId":"list_brands","summary":"List brands (email and in-app styling presets) with ID, name, version and publish time. Use for \"Which brands are set up","description":"List brands (email and in-app styling presets) with ID, name, version and publish time. Use for \"Which brands are set up in Courier\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: pass paging.cursor from the previous answer to get the next page.","title":"Cursor"}},"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_notification_templates":{"post":{"operationId":"list_notification_templates","summary":"List notification templates with ID, name or title, tags, state (DRAFT or PUBLISHED) and timestamps. Use for \"Which noti","description":"List notification templates with ID, name or title, tags, state (DRAFT or PUBLISHED) and timestamps. Use for \"Which notification templates exist in Courier and which are published\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: pass paging.cursor from the previous answer to get the next page.","title":"Cursor"},"tags":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated tag names; returns templates that have all of them.","title":"Tags"},"event_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only templates linked to this event map ID.","title":"Event Id"}},"title":"list_notification_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}},"/v1/tools/list_tenants":{"post":{"operationId":"list_tenants","summary":"List tenants (customer or workspace scopes) with ID, name, parent and default brand. Up to 100 per page. Use for \"Which ","description":"List tenants (customer or workspace scopes) with ID, name, parent and default brand. Up to 100 per page. Use for \"Which tenants are defined in Courier\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: pass paging.cursor from the previous answer to get the next page.","title":"Cursor"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many tenants to return (1 to 100, default 20).","title":"Limit"},"parent_tenant_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only child tenants of this tenant ID.","title":"Parent Tenant Id"}},"title":"list_tenantsArguments","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_audit_events":{"post":{"operationId":"list_audit_events","summary":"List audit events (who changed what in the workspace) with actor, target, source, type and time. Use for \"Who changed th","description":"List audit events (who changed what in the workspace) with actor, target, source, type and time. Use for \"Who changed things in my Courier workspace recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor: pass paging.cursor from the previous answer to get the next page.","title":"Cursor"}},"title":"list_audit_eventsArguments","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}}}}