{"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:inboxroute/get-contacts":{"get":{"operationId":"communication_inboxroute_get_contacts","summary":"Get a paged result of contacts from a list","description":"GET /contacts","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"listid","in":"query","required":false,"description":"Unique 16 characters ID of the contact list to get contacts of","schema":{"type":"string","description":"Unique 16 characters ID of the contact list to get contacts of"}},{"name":"offset","in":"query","required":false,"description":"Skip that many records","schema":{"type":"integer","description":"Skip that many records"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items in page","schema":{"type":"integer","description":"Maximum number of items in page"}},{"name":"sort","in":"query","required":false,"description":"Property to sort by. Append '-' for descending order.","schema":{"type":"string","description":"Property to sort by. Append '-' for descending order."}}],"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:inboxroute/get-contacts-lists":{"get":{"operationId":"communication_inboxroute_get_contacts_lists","summary":"Get a paged result of contact lists.","description":"GET /contacts/lists","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"offset","in":"query","required":false,"description":"Skip that many records","schema":{"type":"integer","description":"Skip that many records"}},{"name":"limit","in":"query","required":false,"description":"Maximum number of items in page","schema":{"type":"integer","description":"Maximum number of items in page"}},{"name":"sort","in":"query","required":false,"description":"Property to sort by. Append '-' for descending order.","schema":{"type":"string","description":"Property to sort by. Append '-' for descending order."}}],"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:inboxroute/post-contacts-lists":{"post":{"operationId":"communication_inboxroute_post_contacts_lists","summary":"Add a new contact list","description":"POST /contacts/lists","tags":["communication"],"x-apizie-access":"write","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:inboxroute/put-contacts-lists-listid":{"post":{"operationId":"communication_inboxroute_put_contacts_lists_listid","summary":"Update an existing contact list","description":"PUT /contacts/lists/{listid}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["listid"],"properties":{"listid":{"type":"string","description":"Unique 16 characters ID of the contact list"},"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:inboxroute/delete-contacts-lists-listid":{"post":{"operationId":"communication_inboxroute_delete_contacts_lists_listid","summary":"Delete an existing contact list","description":"DELETE /contacts/lists/{listid}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["listid"],"properties":{"listid":{"type":"string","description":"Unique 16 characters ID of the contact list"}}}}}},"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:inboxroute/put-contacts-contactid":{"post":{"operationId":"communication_inboxroute_put_contacts_contactid","summary":"Update an existing contact","description":"PUT /contacts/{contactid}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contactid","body"],"properties":{"contactid":{"type":"string","description":"Unique 16 characters ID of the contact"},"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:inboxroute/delete-contacts-contactid":{"post":{"operationId":"communication_inboxroute_delete_contacts_contactid","summary":"Delete an existing contact","description":"DELETE /contacts/{contactid}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contactid"],"properties":{"contactid":{"type":"string","description":"Unique 16 characters ID of the contact"}}}}}},"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:inboxroute/post-subscription-listid":{"post":{"operationId":"communication_inboxroute_post_subscription_listid","summary":"Subscribe an email address to a list. This api call has the same behavior as a regular subscribe form.…","description":"POST /subscription/{listid}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["listid","body"],"properties":{"listid":{"type":"string","description":"Unique 16 characters ID of the contact list"},"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"}}}}}}}