{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:goody/me-get-current-user":{"get":{"operationId":"communication_goody_me_get_current_user","summary":"Retrieve current user","description":"GET /v1/me","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/order-batches-list":{"get":{"operationId":"communication_goody_order_batches_list","summary":"List order batches","description":"GET /v1/order_batches","tags":["communication"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page for pagination, starting at 1","schema":{"type":"integer","default":1,"description":"Page for pagination, starting at 1"}},{"name":"per_page","in":"query","required":false,"description":"Items per page for pagination","schema":{"type":"integer","default":20,"description":"Items per page for pagination"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/order-batches-create-batch":{"post":{"operationId":"communication_goody_order_batches_create_batch","summary":"Create an order batch","description":"POST /v1/order_batches","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:goody/order-batches-get-orders":{"get":{"operationId":"communication_goody_order_batches_get_orders","summary":"Retrieve orders for an order batch","description":"GET /v1/order_batches/{id}/orders","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Order batch ID","schema":{"type":"string","description":"Order batch ID"}},{"name":"page","in":"query","required":false,"description":"Page for pagination, starting at 1","schema":{"type":"integer","default":1,"description":"Page for pagination, starting at 1"}},{"name":"per_page","in":"query","required":false,"description":"Items per page for pagination","schema":{"type":"integer","default":20,"description":"Items per page for pagination"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/order-batches-get-recipients":{"get":{"operationId":"communication_goody_order_batches_get_recipients","summary":"Retrieve recipients for an order batch","description":"GET /v1/order_batches/{id}/recipients","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Order batch ID","schema":{"type":"string","description":"Order batch ID"}},{"name":"page","in":"query","required":false,"description":"Page for pagination, starting at 1","schema":{"type":"integer","default":1,"description":"Page for pagination, starting at 1"}},{"name":"per_page","in":"query","required":false,"description":"Items per page for pagination","schema":{"type":"integer","default":20,"description":"Items per page for pagination"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/order-batches-get":{"get":{"operationId":"communication_goody_order_batches_get","summary":"Retrieve an order batch","description":"GET /v1/order_batches/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Order batch ID","schema":{"type":"string","description":"Order batch ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/orders-cancel-order":{"post":{"operationId":"communication_goody_orders_cancel_order","summary":"Cancel an order","description":"POST /v1/orders/{id}/cancel","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:goody/orders-get-list":{"get":{"operationId":"communication_goody_orders_get_list","summary":"List orders","description":"GET /v1/orders","tags":["communication"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page for pagination, starting at 1","schema":{"type":"integer","default":1,"description":"Page for pagination, starting at 1"}},{"name":"per_page","in":"query","required":false,"description":"Items per page for pagination","schema":{"type":"integer","default":20,"description":"Items per page for pagination"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/orders-get-by-id":{"get":{"operationId":"communication_goody_orders_get_by_id","summary":"Retrieve an order","description":"GET /v1/orders/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"id","schema":{"type":"string","description":"id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/orders-update-expiration":{"post":{"operationId":"communication_goody_orders_update_expiration","summary":"Update expiration for an order","description":"POST /v1/orders/{id}/update_expiration","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:goody/payment-methods-list-all":{"get":{"operationId":"communication_goody_payment_methods_list_all","summary":"List all payment methods","description":"GET /v1/payment_methods","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/products-list-active-products":{"get":{"operationId":"communication_goody_products_list_active_products","summary":"List all active products","description":"GET /v1/products","tags":["communication"],"parameters":[{"name":"page","in":"query","required":false,"description":"Page for pagination, starting at 1","schema":{"type":"integer","default":1,"description":"Page for pagination, starting at 1"}},{"name":"per_page","in":"query","required":false,"description":"Items per page for pagination","schema":{"type":"integer","default":20,"description":"Items per page for pagination"}},{"name":"use_custom_catalog","in":"query","required":false,"description":"Limit to custom catalog only (for approved API partners)","schema":{"type":"boolean","description":"Limit to custom catalog only (for approved API partners)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:goody/webhooks-create-endpoint":{"post":{"operationId":"communication_goody_webhooks_create_endpoint","summary":"Create a webhook endpoint","description":"POST /v1/webhooks","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:goody/webhooks-delete-endpoint":{"post":{"operationId":"communication_goody_webhooks_delete_endpoint","summary":"Delete a webhook endpoint","description":"DELETE /v1/webhooks/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Webhook endpoint ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:goody/workspaces-get-all":{"get":{"operationId":"communication_goody_workspaces_get_all","summary":"List all workspaces","description":"GET /v1/workspaces","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}