{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:hubspot-automation-automation-v4/get-automation-v4-flows":{"get":{"operationId":"business_hubspot_automation_automation_v4_get_automation_v4_flows","summary":"Retrieve workflows","description":"GET /automation/v4/flows","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"after","in":"query","required":false,"description":"The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged…","schema":{"type":"string","description":"The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to display per page.","schema":{"type":"integer","default":100,"description":"The maximum number of results to display per page."}}],"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/business:hubspot-automation-automation-v4/post-automation-v4-flows":{"post":{"operationId":"business_hubspot_automation_automation_v4_post_automation_v4_flows","summary":"Create a workflow","description":"POST /automation/v4/flows","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/business:hubspot-automation-automation-v4/post-automation-v4-flows-batch-read":{"post":{"operationId":"business_hubspot_automation_automation_v4_post_automation_v4_flows_batch_read","summary":"Retrieve workflows","description":"POST /automation/v4/flows/batch/read","tags":["business"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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/business:hubspot-automation-automation-v4/get-automation-v4-flows-email-campaigns":{"get":{"operationId":"business_hubspot_automation_automation_v4_get_automation_v4_flows_email_campaigns","summary":"Retrieve workflow email campaigns","description":"GET /automation/v4/flows/email-campaigns","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"after","in":"query","required":false,"description":"The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged…","schema":{"type":"string","description":"The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged…"}},{"name":"before","in":"query","required":false,"schema":{"type":"string"}},{"name":"flowId","in":"query","required":false,"schema":{"type":"array"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results to display per page.","schema":{"type":"integer","description":"The maximum number of results to display per page."}}],"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/business:hubspot-automation-automation-v4/get-automation-v4-flows-performance-flow-id-automation-v4-fl":{"get":{"operationId":"business_hubspot_automation_automation_v4_get_automation_v4_flows_performance_flow_id_automation_v4_fl","summary":"GET /automation/v4/flows/performance/{flowId}","description":"GET /automation/v4/flows/performance/{flowId}","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"flowId","in":"query","required":true,"schema":{"type":"string"}},{"name":"bucketType","in":"query","required":false,"schema":{"type":"string","enum":["DAY","MONTH","WEEK"]}},{"name":"end","in":"query","required":false,"schema":{"type":"integer"}},{"name":"firstDay","in":"query","required":false,"schema":{"type":"string","enum":["FRIDAY","MONDAY","SATURDAY","SUNDAY","THURSDAY","TUESDAY","WEDNESDAY"]}},{"name":"start","in":"query","required":false,"schema":{"type":"integer"}}],"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/business:hubspot-automation-automation-v4/get-automation-v4-flows-flow-id":{"get":{"operationId":"business_hubspot_automation_automation_v4_get_automation_v4_flows_flow_id","summary":"Retrieve a workflow","description":"GET /automation/v4/flows/{flowId}","tags":["business"],"x-apizie-access":"read","parameters":[{"name":"flowId","in":"query","required":true,"schema":{"type":"string"}}],"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/business:hubspot-automation-automation-v4/put-automation-v4-flows-flow-id":{"post":{"operationId":"business_hubspot_automation_automation_v4_put_automation_v4_flows_flow_id","summary":"Update a workflow","description":"PUT /automation/v4/flows/{flowId}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["flowId","body"],"properties":{"flowId":{"type":"string"},"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/business:hubspot-automation-automation-v4/delete-automation-v4-flows-flow-id":{"post":{"operationId":"business_hubspot_automation_automation_v4_delete_automation_v4_flows_flow_id","summary":"Delete a workflow","description":"DELETE /automation/v4/flows/{flowId}","tags":["business"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["flowId"],"properties":{"flowId":{"type":"integer"}}}}}},"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/business:hubspot-automation-automation-v4/post-automation-v4-workflow-id-mappings-batch-read":{"post":{"operationId":"business_hubspot_automation_automation_v4_post_automation_v4_workflow_id_mappings_batch_read","summary":"Retrieve workflow ID mappings","description":"POST /automation/v4/workflow-id-mappings/batch/read","tags":["business"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"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"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"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"}}}}}}}