{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/business:onna/custom-fields-list":{"get":{"operationId":"business_onna_custom_fields_list","summary":"List Custom Fields","description":"GET /customFields","tags":["business"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)","schema":{"type":"string","description":"The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)"},"example":"2022-02-22T11:11:11.12345"}],"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:onna/custom-fields-create-field":{"post":{"operationId":"business_onna_custom_fields_create_field","summary":"Create Custom Field","description":"POST /customFields","tags":["business"],"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:onna/folders-create-new-folder":{"post":{"operationId":"business_onna_folders_create_new_folder","summary":"Create Folder","description":"POST /folders","tags":["business"],"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:onna/folders-get-info":{"get":{"operationId":"business_onna_folders_get_info","summary":"Retrieve Folder Info","description":"GET /folders/{onna_id}","tags":["business"],"parameters":[{"name":"onna_id","in":"query","required":true,"description":"Unique ID of the folder.","schema":{"type":"string","description":"Unique ID of the folder."}}],"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:onna/folders-update-folder-name":{"post":{"operationId":"business_onna_folders_update_folder_name","summary":"Update Folder","description":"PATCH /folders/{onna_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["onna_id","body"],"properties":{"onna_id":{"type":"string","description":"Unique ID of the folder."},"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:onna/folders-delete-folder":{"post":{"operationId":"business_onna_folders_delete_folder","summary":"Delete Folder","description":"DELETE /folders/{onna_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["onna_id"],"properties":{"onna_id":{"type":"string","description":"Unique ID of the folder."}}}}}},"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:onna/utils-check-service-status":{"get":{"operationId":"business_onna_utils_check_service_status","summary":"Health Check","description":"GET /health","tags":["business"],"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/business:onna/authentication-exchange-credentials":{"post":{"operationId":"business_onna_authentication_exchange_credentials","summary":"Login","description":"POST /oauth/token","tags":["business"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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/business:onna/authentication-current-user-info":{"get":{"operationId":"business_onna_authentication_current_user_info","summary":"Current User","description":"GET /oauth/user","tags":["business"],"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/business:onna/resources-files-create-new-file":{"post":{"operationId":"business_onna_resources_files_create_new_file","summary":"Create File","description":"POST /resources/files","tags":["business"],"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:onna/resources-files-get-file":{"get":{"operationId":"business_onna_resources_files_get_file","summary":"Read File","description":"GET /resources/files/{onna_id}","tags":["business"],"parameters":[{"name":"onna_id","in":"query","required":true,"description":"Unique ID of the file.","schema":{"type":"string","description":"Unique ID of the file."}}],"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:onna/resources-files-delete-file":{"post":{"operationId":"business_onna_resources_files_delete_file","summary":"Delete File","description":"DELETE /resources/files/{onna_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["onna_id"],"properties":{"onna_id":{"type":"string","description":"Unique ID of the file."}}}}}},"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:onna/resources-tickets-create-new-ticket":{"post":{"operationId":"business_onna_resources_tickets_create_new_ticket","summary":"Create Ticket","description":"POST /resources/tickets","tags":["business"],"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:onna/resources-tickets-get-ticket":{"get":{"operationId":"business_onna_resources_tickets_get_ticket","summary":"Read Ticket","description":"GET /resources/tickets/{onna_id}","tags":["business"],"parameters":[{"name":"onna_id","in":"query","required":true,"description":"Unique ID of the ticket.","schema":{"type":"string","description":"Unique ID of the ticket."}}],"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:onna/resources-tickets-remove-ticket":{"post":{"operationId":"business_onna_resources_tickets_remove_ticket","summary":"Delete Ticket","description":"DELETE /resources/tickets/{onna_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["onna_id"],"properties":{"onna_id":{"type":"string","description":"Unique ID of the ticket."}}}}}},"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:onna/upload-resource-file-resumable-upload":{"post":{"operationId":"business_onna_upload_resource_file_resumable_upload","summary":"Create Resource File Resumable Upload","description":"POST /upload/{id}/tus","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"upload-defer-length":{"type":"string","description":"The `Upload-Defer-Length` request and response header indicates that the size of the upload is not known currently and will be transferred…"},"upload-length":{"type":"string","description":"The `Upload-Length` request and response header indicates the size of the entire upload in bytes. The value MUST be a non-negative…"},"upload-metadata":{"type":"string","description":"The `Upload-Metadata` request and response header MUST consist of one or more comma-separated key-value pairs. The key and value MUST be…"},"tus-resumable":{"type":"string","description":"The `Tus-Resumable` header is included in every request and response. ```bash Tus-Resumable: 1.0.0 ``` For more information on the headers…"}}}}}},"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:onna/upload-resource-single-request":{"post":{"operationId":"business_onna_upload_resource_single_request","summary":"Create Resource File Single Request","description":"PUT /upload/{id}/tus","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/business:onna/upload-resume-resource-file":{"post":{"operationId":"business_onna_upload_resume_resource_file","summary":"Resume Resource File Upload","description":"PATCH /upload/{id}/tus","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"},"content-length":{"type":"string","description":"The `Content-Length` header indicates the size of the message body, in bytes, sent to the recipient. ```bash Content-Length: 512 ``` For…"},"upload-offset":{"type":"string","description":"The `Upload-Offset` request and response header indicates a byte offset within a resource. The value MUST be a non-negative integer.…"},"tus-resumable":{"type":"string","description":"The `Tus-Resumable` header is included in every request and response. ```bash Tus-Resumable: 1.0.0 ``` For more information on the headers…"}}}}}},"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:onna/workspaces-list":{"get":{"operationId":"business_onna_workspaces_list","summary":"List Workspaces","description":"GET /workspaces","tags":["business"],"parameters":[{"name":"cursor","in":"query","required":false,"description":"The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)","schema":{"type":"string","description":"The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)"},"example":"2022-02-22T11:11:11.12345"}],"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:onna/workspaces-create":{"post":{"operationId":"business_onna_workspaces_create","summary":"Create Workspace","description":"POST /workspaces","tags":["business"],"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:onna/workspaces-get-info":{"get":{"operationId":"business_onna_workspaces_get_info","summary":"Retrieve Workspace Info","description":"GET /workspaces/{onna_id}","tags":["business"],"parameters":[{"name":"onna_id","in":"query","required":true,"description":"Unique ID of the workspace.","schema":{"type":"string","description":"Unique ID of the workspace."},"example":"myworkspace-ZPM9Jf4zQ"}],"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:onna/workspaces-update-workspace":{"post":{"operationId":"business_onna_workspaces_update_workspace","summary":"Update Workspace","description":"PATCH /workspaces/{onna_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["onna_id","body"],"properties":{"onna_id":{"type":"string","description":"Unique ID of the workspace."},"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:onna/workspaces-remove-workspace":{"post":{"operationId":"business_onna_workspaces_remove_workspace","summary":"Delete Workspace","description":"DELETE /workspaces/{onna_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["onna_id"],"properties":{"onna_id":{"type":"string","description":"Unique ID of the workspace."}}}}}},"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:onna/workspaces-list-custom-fields":{"get":{"operationId":"business_onna_workspaces_list_custom_fields","summary":"List Workspace Custom Fields","description":"GET /workspaces/{onna_id}/customFields","tags":["business"],"parameters":[{"name":"onna_id","in":"query","required":true,"description":"Unique ID of the workspace.","schema":{"type":"string","description":"Unique ID of the workspace."},"example":"myworkspace-ZPM9Jf4zQ"},{"name":"cursor","in":"query","required":false,"description":"The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)","schema":{"type":"string","description":"The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)"},"example":"2022-02-22T11:11:11.12345"}],"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:onna/workspaces-enable-custom-field":{"post":{"operationId":"business_onna_workspaces_enable_custom_field","summary":"Enable Workspace Custom Field","description":"PATCH /workspaces/{onna_id}/customFields","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["onna_id","body"],"properties":{"onna_id":{"type":"string","description":"Unique ID of the workspace."},"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:onna/workspaces-read-custom-value":{"get":{"operationId":"business_onna_workspaces_read_custom_value","summary":"Read Workspace Custom Value","description":"GET /workspaces/{onna_id}/customFields/{field_id}","tags":["business"],"parameters":[{"name":"onna_id","in":"query","required":true,"description":"Unique ID of the workspace.","schema":{"type":"string","description":"Unique ID of the workspace."},"example":"myworkspace-ZPM9Jf4zQ"},{"name":"field_id","in":"query","required":true,"description":"Unique ID of the field.","schema":{"type":"string","description":"Unique ID of the field."},"example":"cf-b20696ae9"}],"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:onna/workspaces-update-custom-value":{"post":{"operationId":"business_onna_workspaces_update_custom_value","summary":"Update Workspace Custom Value","description":"PATCH /workspaces/{onna_id}/customFields/{field_id}","tags":["business"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["onna_id","field_id","body"],"properties":{"onna_id":{"type":"string","description":"Unique ID of the workspace."},"field_id":{"type":"string","description":"Unique ID of the field."},"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":"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"}}}}}}}