{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Organization API", "version": "v2" }, "items": [ { "info": { "name": "Organization", "type": "folder" }, "items": [ { "info": { "name": "Get the list of domains that will be allowed to embed PureCloud applications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/embeddedintegration" }, "docs": "This route is deprecated, please use /api/v2/organizations/authentication/settings instead" }, { "info": { "name": "Update the list of domains that will be allowed to embed PureCloud applications", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/organizations/embeddedintegration" }, "docs": "This route is deprecated, please use /api/v2/organizations/authentication/settings instead" }, { "info": { "name": "Get organization IP address whitelist settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/ipaddressauthentication" }, "docs": "This route is deprecated, please use /api/v2/organizations/authentication/settings instead" }, { "info": { "name": "Update organization IP address whitelist settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/organizations/ipaddressauthentication" }, "docs": "This route is deprecated, please use /api/v2/organizations/authentication/settings instead" }, { "info": { "name": "This route is deprecated, please use /api/v2/organizations/authentication/settings instead", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/whitelist" }, "docs": "This route is deprecated, please use /api/v2/organizations/authentication/settings instead" }, { "info": { "name": "This route is deprecated, please use /api/v2/organizations/authentication/settings instead", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/organizations/whitelist" }, "docs": "This route is deprecated, please use /api/v2/organizations/authentication/settings instead" }, { "info": { "name": "Gets the organization's settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/authentication/settings" }, "docs": "Gets the organization's settings" }, { "info": { "name": "Update the organization's settings", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/organizations/authentication/settings" }, "docs": "Update the organization's settings" }, { "info": { "name": "Fetch field config for an entity type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/fieldconfig", "params": [ { "name": "type", "value": "", "type": "query", "description": "Field type" } ] }, "docs": "Fetch field config for an entity type" }, { "info": { "name": "Update organization", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/organizations/features/:featureName", "params": [ { "name": "featureName", "value": "", "type": "path", "description": "Organization feature" } ] }, "docs": "Update organization" }, { "info": { "name": "Get organization.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/me" }, "docs": "Get organization." }, { "info": { "name": "Update organization.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/organizations/me" }, "docs": "Update organization." }, { "info": { "name": "Get a limit change request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/limits/changerequests/:requestId", "params": [ { "name": "requestId", "value": "", "type": "path", "description": "Unique id for the limit change request" } ] }, "docs": "Get a limit change request" }, { "info": { "name": "Get the available limit change requests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/limits/changerequests", "params": [ { "name": "after", "value": "", "type": "query", "description": "Timestamp indicating the date to begin after when searching for requests." }, { "name": "before", "value": "", "type": "query", "description": "Timestamp indicating the date to end before when searching for requests." }, { "name": "status", "value": "", "type": "query", "description": "Status of the request to be filtered by" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page Size" }, { "name": "expand", "value": "", "type": "query", "description": "Which fields, if any, to expand." } ] }, "docs": "Timestamp interval defaults to the last 365 days if both query parameters are omitted. If only one parameter is omitted, the interval will default to a 180 day range in the specified direction." }, { "info": { "name": "Get limit documentation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/limits/docs" }, "docs": "Get limit documentation" }, { "info": { "name": "Get free trial limit documentation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/limits/docs/freetrial" }, "docs": "Get free trial limit documentation" }, { "info": { "name": "Get the available limit namespaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/limits/namespaces", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get the available limit namespaces" }, { "info": { "name": "Get the effective limits in a namespace for an organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/limits/namespaces/:namespaceName", "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The namespace to fetch limits for" } ] }, "docs": "Get the effective limits in a namespace for an organization" }, { "info": { "name": "Get the default limits in a namespace for an organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/organizations/limits/namespaces/:namespaceName/defaults", "params": [ { "name": "namespaceName", "value": "", "type": "path", "description": "The namespace to fetch defaults limits for" } ] }, "docs": "Get the default limits in a namespace for an organization" } ] } ], "bundled": true }