{"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/communication:webex-webex-broadworks/list-broad-works-billing-reports":{"get":{"operationId":"communication_webex_webex_broadworks_list_broad_works_billing_reports","summary":"List BroadWorks Billing Reports","description":"GET /broadworks/billing/reports","tags":["communication"],"parameters":[{"name":"before","in":"query","required":false,"description":"Only include billing reports created before this date.","schema":{"type":"string","description":"Only include billing reports created before this date."},"example":"2020-03"},{"name":"after","in":"query","required":false,"description":"Only include billing reports created after this date.","schema":{"type":"string","description":"Only include billing reports created after this date."},"example":"2019-12"},{"name":"sortBy","in":"query","required":false,"description":"Sort the reports. + Members: + id + status + billingPeriod","schema":{"type":"string","default":"billingPeriod","description":"Sort the reports. + Members: + id + status + billingPeriod"},"example":"billingPeriod"}],"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:webex-webex-broadworks/create-a-broad-works-billing-report":{"post":{"operationId":"communication_webex_webex_broadworks_create_a_broad_works_billing_report","summary":"Create a BroadWorks Billing Report","description":"POST /broadworks/billing/reports","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:webex-webex-broadworks/get-a-broad-works-billing-report":{"get":{"operationId":"communication_webex_webex_broadworks_get_a_broad_works_billing_report","summary":"Get a BroadWorks Billing Report","description":"GET /broadworks/billing/reports/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"A unique identifier for the report in request.","schema":{"type":"string","description":"A unique identifier for the report in request."},"example":"Y2lzY29zcGFyazovL3VzL0JJTExJTkdfUkVQT1JULzViOGQ1MThhLThmMDAtNDUxYi1hNDA2LWVhZjQ5YjRhN2ZhOA"}],"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:webex-webex-broadworks/delete-a-broad-works-billing-report":{"post":{"operationId":"communication_webex_webex_broadworks_delete_a_broad_works_billing_report","summary":"Delete a BroadWorks Billing Report","description":"DELETE /broadworks/billing/reports/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"A unique report ID that corresponds to a billing report."}}}}}},"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:webex-webex-broadworks/list-broad-works-enterprises":{"get":{"operationId":"communication_webex_webex_broadworks_list_broad_works_enterprises","summary":"List BroadWorks Enterprises","description":"GET /broadworks/enterprises","tags":["communication"],"parameters":[{"name":"spEnterpriseId","in":"query","required":false,"description":"The Service Provider supplied unique identifier for the subscriber's enterprise.","schema":{"type":"string","description":"The Service Provider supplied unique identifier for the subscriber's enterprise."},"example":"Reseller1+acme"},{"name":"startsWith","in":"query","required":false,"description":"The starting string of the enterprise identifiers to match against.","schema":{"type":"string","description":"The starting string of the enterprise identifiers to match against."},"example":"Res"},{"name":"max","in":"query","required":false,"description":"Limit the number of enterprises returned in the search, up to 1000.","schema":{"type":"number","default":100,"description":"Limit the number of enterprises returned in the search, up to 1000."},"example":"10"}],"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:webex-webex-broadworks/get-directory-sync-status-for-an-enterprise":{"get":{"operationId":"communication_webex_webex_broadworks_get_directory_sync_status_for_an_enterprise","summary":"Get Directory Sync Status for an Enterprise","description":"GET /broadworks/enterprises/{id}/broadworksDirectorySync","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"A unique identifier for the enterprise in question.","schema":{"type":"string","description":"A unique identifier for the enterprise in question."},"example":"Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk"}],"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:webex-webex-broadworks/trigger-directory-sync-for-an-enterprise":{"post":{"operationId":"communication_webex_webex_broadworks_trigger_directory_sync_for_an_enterprise","summary":"Trigger Directory Sync for an Enterprise","description":"POST /broadworks/enterprises/{id}/broadworksDirectorySync","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"A unique identifier for the enterprise in question."},"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:webex-webex-broadworks/update-directory-sync-for-a-broad-works-enterprise":{"post":{"operationId":"communication_webex_webex_broadworks_update_directory_sync_for_a_broad_works_enterprise","summary":"Update Directory Sync for a BroadWorks Enterprise","description":"PUT /broadworks/enterprises/{id}/broadworksDirectorySync","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"A unique identifier for the enterprise in question."},"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:webex-webex-broadworks/trigger-directory-sync-for-a-user":{"post":{"operationId":"communication_webex_webex_broadworks_trigger_directory_sync_for_a_user","summary":"Trigger Directory Sync for a User","description":"POST /broadworks/enterprises/{id}/broadworksDirectorySync/externalUser","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"A unique identifier for the enterprise in question."},"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:webex-webex-broadworks/list-broad-works-subscribers":{"get":{"operationId":"communication_webex_webex_broadworks_list_broad_works_subscribers","summary":"List BroadWorks Subscribers","description":"GET /broadworks/subscribers","tags":["communication"],"parameters":[{"name":"userId","in":"query","required":false,"description":"The user ID of the subscriber on BroadWorks.","schema":{"type":"string","description":"The user ID of the subscriber on BroadWorks."},"example":"95547321@sp.com"},{"name":"personId","in":"query","required":false,"description":"The Person ID of the Webex subscriber.","schema":{"type":"string","description":"The Person ID of the Webex subscriber."},"example":"Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY"},{"name":"email","in":"query","required":false,"description":"The email address of the subscriber.","schema":{"type":"string","description":"The email address of the subscriber."},"example":"john.anderson@acme.com"},{"name":"provisioningId","in":"query","required":false,"description":"The Provisioning ID associated with this subscriber.","schema":{"type":"string","description":"The Provisioning ID associated with this subscriber."},"example":"ZjViMzYxODctYzhkZC00NzI3LThiMmYtZjljNDQ3ZjI5MDQ2OjQyODVmNTk0LTViNTEtNDdiZS05Mzk2LTZjMzZlMmFkODNhNQ"},{"name":"spEnterpriseId","in":"query","required":false,"description":"The Service Provider supplied unique identifier for the subscriber's enterprise.","schema":{"type":"string","description":"The Service Provider supplied unique identifier for the subscriber's enterprise."},"example":"SP1+Acme"},{"name":"lastStatusChange","in":"query","required":false,"description":"Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601…","schema":{"type":"string","description":"Only include subscribers with a provisioning status change after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601…"},"example":"1579046400245"},{"name":"status","in":"query","required":false,"description":"The provisioning status of the subscriber. This Parameter supports multiple comma separated values. For example :…","schema":{"type":"string","enum":["pending_email_input","pending_email_validation","pending_user_migration","provisioning","provisioned","updating","error"],"description":"The provisioning status of the subscriber. This Parameter supports multiple comma separated values. For example :…"},"example":"pending_email_input"},{"name":"after","in":"query","required":false,"description":"Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted.","schema":{"type":"string","description":"Only include subscribers created after this date and time. Epoch time (in milliseconds) preferred, but ISO 8601 date format also accepted."},"example":"1579046400245"},{"name":"selfActivated","in":"query","required":false,"description":"Indicates if the subscriber was self activated, rather than provisioned via these APIs.","schema":{"type":"boolean","description":"Indicates if the subscriber was self activated, rather than provisioned via these APIs."},"example":"false"},{"name":"max","in":"query","required":false,"description":"Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the…","schema":{"type":"integer","default":50,"description":"Limit the maximum number of subscribers returned in the search response, up to 100 per page. Refer to the…"},"example":"10"}],"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:webex-webex-broadworks/provision-a-broad-works-subscriber":{"post":{"operationId":"communication_webex_webex_broadworks_provision_a_broad_works_subscriber","summary":"Provision a BroadWorks Subscriber","description":"POST /broadworks/subscribers","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:webex-webex-broadworks/get-a-broad-works-subscriber":{"get":{"operationId":"communication_webex_webex_broadworks_get_a_broad_works_subscriber","summary":"Get a BroadWorks Subscriber","description":"GET /broadworks/subscribers/{subscriberId}","tags":["communication"],"parameters":[{"name":"subscriberId","in":"query","required":true,"description":"A unique identifier for the subscriber in question.","schema":{"type":"string","description":"A unique identifier for the subscriber in question."},"example":"Y2lzY29zcGFyazovL3VzL1NVQlNDUklCRVIvNjk3MGU2YmItNzQzOS00ZmZiLWFkMzQtZDNmZjAxNjdkZGFk"}],"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:webex-webex-broadworks/update-a-broad-works-subscriber":{"post":{"operationId":"communication_webex_webex_broadworks_update_a_broad_works_subscriber","summary":"Update a BroadWorks Subscriber","description":"PUT /broadworks/subscribers/{subscriberId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriberId"],"properties":{"subscriberId":{"type":"string","description":"A unique identifier for the subscriber in question."},"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:webex-webex-broadworks/remove-a-broad-works-subscriber":{"post":{"operationId":"communication_webex_webex_broadworks_remove_a_broad_works_subscriber","summary":"Remove a BroadWorks Subscriber","description":"DELETE /broadworks/subscribers/{subscriberId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriberId"],"properties":{"subscriberId":{"type":"string","description":"A unique identifier for the subscriber in question."}}}}}},"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:webex-webex-broadworks/precheck-a-broadworks-subscriber-provisioning":{"post":{"operationId":"communication_webex_webex_broadworks_precheck_a_broadworks_subscriber_provisioning","summary":"Precheck a Broadworks Subscriber Provisioning","description":"POST /broadworks/subscribers/validate","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:webex-webex-broadworks/send-consent-user-move-email-to-pending-broadworks-subscribe":{"post":{"operationId":"communication_webex_webex_broadworks_send_consent_user_move_email_to_pending_broadworks_subscribe","summary":"Send Consent User Move Email to Pending Broadworks Subscribers","description":"POST /subscribers/{subscriberId}/emails/consentMove","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriberId"],"properties":{"subscriberId":{"type":"string","description":"A unique identifier for the subscriber in question."}}}}}},"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:webex-webex-broadworks/provision-broad-works-workspace":{"post":{"operationId":"communication_webex_webex_broadworks_provision_broad_works_workspace","summary":"Provision a BroadWorks Workspace","description":"POST /broadworks/workspaces","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:webex-webex-broadworks/update-broadworks-workspace":{"post":{"operationId":"communication_webex_webex_broadworks_update_broadworks_workspace","summary":"Update a Broadworks Workspace","description":"PUT /broadworks/workspaces/{workspaceId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","description":"A unique Cisco identifier for 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/communication:webex-webex-broadworks/remove-broad-works-workspace":{"post":{"operationId":"communication_webex_webex_broadworks_remove_broad_works_workspace","summary":"Remove a BroadWorks Workspace","description":"DELETE /broadworks/workspaces/{workspaceId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"workspaceId":{"type":"string","description":"A unique Cisco identifier for 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"}}},"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"}}}}}}}