{"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/communication:twilio-twilio-bulkexports-v1/fetch-day":{"get":{"operationId":"communication_twilio_twilio_bulkexports_v1_fetch_day","summary":"Fetch a specific Day.","description":"GET /v1/Exports/{ResourceType}/Days/{Day}","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"ResourceType","in":"query","required":true,"description":"The type of communication – Messages, Calls, Conferences, and Participants","schema":{"type":"string","description":"The type of communication – Messages, Calls, Conferences, and Participants"}},{"name":"Day","in":"query","required":true,"description":"The ISO 8601 format date of the resources in the file, for a UTC day","schema":{"type":"string","description":"The ISO 8601 format date of the resources in the file, for a UTC day"}}],"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:twilio-twilio-bulkexports-v1/list-day":{"get":{"operationId":"communication_twilio_twilio_bulkexports_v1_list_day","summary":"Retrieve a list of all Days for a resource.","description":"GET /v1/Exports/{ResourceType}/Days","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"ResourceType","in":"query","required":true,"description":"The type of communication – Messages, Calls, Conferences, and Participants","schema":{"type":"string","description":"The type of communication – Messages, Calls, Conferences, and Participants"}},{"name":"PageSize","in":"query","required":false,"description":"How many resources to return in each list page. The default is 50, and the maximum is 400.","schema":{"type":"integer","description":"How many resources to return in each list page. The default is 50, and the maximum is 400."}},{"name":"Page","in":"query","required":false,"description":"The page index. This value is simply for client state.","schema":{"type":"integer","description":"The page index. This value is simply for client state."}},{"name":"PageToken","in":"query","required":false,"description":"The page token. This is provided by the API.","schema":{"type":"string","description":"The page token. This is provided by the API."}}],"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:twilio-twilio-bulkexports-v1/fetch-export":{"get":{"operationId":"communication_twilio_twilio_bulkexports_v1_fetch_export","summary":"Fetch a specific Export.","description":"GET /v1/Exports/{ResourceType}","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"ResourceType","in":"query","required":true,"description":"The type of communication – Messages, Calls, Conferences, and Participants","schema":{"type":"string","description":"The type of communication – Messages, Calls, Conferences, and Participants"}}],"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:twilio-twilio-bulkexports-v1/fetch-export-configuration":{"get":{"operationId":"communication_twilio_twilio_bulkexports_v1_fetch_export_configuration","summary":"Fetch a specific Export Configuration.","description":"GET /v1/Exports/{ResourceType}/Configuration","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"ResourceType","in":"query","required":true,"description":"The type of communication – Messages, Calls, Conferences, and Participants","schema":{"type":"string","description":"The type of communication – Messages, Calls, Conferences, and Participants"}}],"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:twilio-twilio-bulkexports-v1/update-export-configuration":{"post":{"operationId":"communication_twilio_twilio_bulkexports_v1_update_export_configuration","summary":"Update a specific Export Configuration.","description":"POST /v1/Exports/{ResourceType}/Configuration","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceType"],"properties":{"ResourceType":{"type":"string","description":"The type of communication – Messages, Calls, Conferences, and Participants"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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:twilio-twilio-bulkexports-v1/list-export-custom-job":{"get":{"operationId":"communication_twilio_twilio_bulkexports_v1_list_export_custom_job","summary":"GET /v1/Exports/{ResourceType}/Jobs","description":"GET /v1/Exports/{ResourceType}/Jobs","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"ResourceType","in":"query","required":true,"description":"The type of communication – Messages, Calls, Conferences, and Participants","schema":{"type":"string","description":"The type of communication – Messages, Calls, Conferences, and Participants"}},{"name":"PageSize","in":"query","required":false,"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","schema":{"type":"integer","description":"How many resources to return in each list page. The default is 50, and the maximum is 1000."}},{"name":"Page","in":"query","required":false,"description":"The page index. This value is simply for client state.","schema":{"type":"integer","description":"The page index. This value is simply for client state."}},{"name":"PageToken","in":"query","required":false,"description":"The page token. This is provided by the API.","schema":{"type":"string","description":"The page token. This is provided by the API."}}],"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:twilio-twilio-bulkexports-v1/create-export-custom-job":{"post":{"operationId":"communication_twilio_twilio_bulkexports_v1_create_export_custom_job","summary":"POST /v1/Exports/{ResourceType}/Jobs","description":"POST /v1/Exports/{ResourceType}/Jobs","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceType"],"properties":{"ResourceType":{"type":"string","description":"The type of communication – Messages or Calls, Conferences, and Participants"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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:twilio-twilio-bulkexports-v1/fetch-job":{"get":{"operationId":"communication_twilio_twilio_bulkexports_v1_fetch_job","summary":"GET /v1/Exports/Jobs/{JobSid}","description":"GET /v1/Exports/Jobs/{JobSid}","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"JobSid","in":"query","required":true,"description":"The unique string that that we created to identify the Bulk Export job","schema":{"type":"string","description":"The unique string that that we created to identify the Bulk Export job"}}],"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:twilio-twilio-bulkexports-v1/delete-job":{"post":{"operationId":"communication_twilio_twilio_bulkexports_v1_delete_job","summary":"DELETE /v1/Exports/Jobs/{JobSid}","description":"DELETE /v1/Exports/Jobs/{JobSid}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobSid"],"properties":{"JobSid":{"type":"string","description":"The unique string that that we created to identify the Bulk Export job"}}}}}},"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"}}}}}}}