interworks.cloud Portal
  • Public API
    • API Explorer
    • Authorization & Authentication
    • Testing the API
    • Pagination Metadata
    • Versioning and Deprecation
    • $filter Parameter
    • $Filter Options
    • $orderby Parameter
    • Updating via Patch Document
    • API Release Notes
    • Tools / SDKs
      • PowerShell Module (PREVIEW)
  • Integration Framework
    • Overview
    • Register a New Connector
    • Describe Third Party System API
    • Define the Data Transformation Schemas
    • Create an Integration Instance
    • Bearer Authentication Scheme Setup
    • Libraries & Examples
    • Connector Report
    • Testing the Integration
    • Connector Scheduler
    • Platform JSON Objects
  • Service Management
    • Introduction to Service Management
    • Understanding the Provisioning Process
    • Introduction to the interworks.cloud Platform
    • Recurring Services
      • When to Use This Approach
      • Get started in 9 minutes
      • Implementation Roadmap
      • Defining your Product Catalog
    • Implementation Guide
      • Register your Application
      • Application Authentication
      • Get Services Definition (Recurring Services)
      • Get Services Definition (Pay Per Use Services)
      • Customer Management
      • Reseller Provisioning
      • Subscription Management
      • Addon Management
      • Resources Calculation
      • Accessing the Public API
      • Pre-check Mechanism
    • Flow Diagram Library
      • Basket Checkout for Unsynchronized Account
      • Basket Checkout for Synchronized Account
      • Basket Checkout (Reseller Provisioning is Supported)
      • Increase Quantity (Storefront)
      • Subscription Creation
      • Subscription Cancellation (Storefront)
      • Subscription Cancellation (BSS)
      • Order Execution (BSS)
      • Account Synchronization (BSS)
      • Trial Upgrade (Storefront)
      • Trial Upgrade (BSS)
    • Use Cases
      • Apply Min/Max Order Quantity
    • Tools
      • API Explorer
  • Payment Gateways
    • Payment Gateway SDK (v2.0)
    • Payment Gateway – Redirection flow
    • Storefront Emulator
  • Developer Resources
    • GitHub
    • NuGet Packages
  • Public API
    • API Explorer
    • Authorization & Authentication
    • Testing the API
    • Pagination Metadata
    • Versioning and Deprecation
    • $filter Parameter
    • $Filter Options
    • $orderby Parameter
    • Updating via Patch Document
    • API Release Notes
    • Tools / SDKs
      • PowerShell Module (PREVIEW)
  • Integration Framework
    • Overview
    • Register a New Connector
    • Describe Third Party System API
    • Define the Data Transformation Schemas
    • Create an Integration Instance
    • Bearer Authentication Scheme Setup
    • Libraries & Examples
    • Connector Report
    • Testing the Integration
    • Connector Scheduler
    • Platform JSON Objects
  • Service Management
    • Introduction to Service Management
    • Understanding the Provisioning Process
    • Introduction to the interworks.cloud Platform
    • Recurring Services
      • When to Use This Approach
      • Get started in 9 minutes
      • Implementation Roadmap
      • Defining your Product Catalog
    • Implementation Guide
      • Register your Application
      • Application Authentication
      • Get Services Definition (Recurring Services)
      • Get Services Definition (Pay Per Use Services)
      • Customer Management
      • Reseller Provisioning
      • Subscription Management
      • Addon Management
      • Resources Calculation
      • Accessing the Public API
      • Pre-check Mechanism
    • Flow Diagram Library
      • Basket Checkout for Unsynchronized Account
      • Basket Checkout for Synchronized Account
      • Basket Checkout (Reseller Provisioning is Supported)
      • Increase Quantity (Storefront)
      • Subscription Creation
      • Subscription Cancellation (Storefront)
      • Subscription Cancellation (BSS)
      • Order Execution (BSS)
      • Account Synchronization (BSS)
      • Trial Upgrade (Storefront)
      • Trial Upgrade (BSS)
    • Use Cases
      • Apply Min/Max Order Quantity
    • Tools
      • API Explorer
  • Payment Gateways
    • Payment Gateway SDK (v2.0)
    • Payment Gateway – Redirection flow
    • Storefront Emulator
  • Developer Resources
    • GitHub
    • NuGet Packages
Generic selectors
Exact matches only
Search in title
Search in content
Post Type Selectors
post
faq
Filter by Categories
Tools / SDKs
Public API
Recurring Services (pre-defined plans)
Integration Framework
Implementation Guide
Service Management
Flow Diagram Library
Payment Gateways
Use Cases
Developer Resources
Tools
Uncategorized
  • Support
  • »
  • Public API

Public API

Rest API enabled data retrieval and execution of
actions available through BSS Portal

API Explorer

This page contains links to the interworks.cloud API documentation,

Authorization & Authentication

To make calls to the interworks.cloud BSS and Billing API you must be authorized and authenticated.

Testing the API

The interworks.cloud API can be tested without writing any code, directly from the documentation.

Pagination Metadata

This page explains how to retrieve and interpret pagination metadata with examples.

Versioning and Deprecation

This page contains information on how the API version is set, its format, and the deprecation policy.

$filter Parameter

The interworks.cloud Platform API provides filtering options on all basic methods that return a collection of resources, using the $filter parameter.

$orderby Parameter

The interworks.cloud Platform API provides ordering options on all basic methods that return a collection of resources using the $orderby parameter.

Updating via Patch Document

The interworks.cloud Platform API supports partial updates of all entities via the HTTP PATCH methods that support JSON Patch.

API Release Notes

This page contains all the latest release notes for the interworks.cloud API

$Filter Options

This page is continued from "Filtering Collections ($filter)" and contains the $filter parameters.

Tools / SDKs

© 2023 interworks.cloud | Helping you take your business to the cloud | IMPRINT

  • Discover

    • Public API
    • Integration Framework
    • Service Management
    • Payment Gateways
    • Developer Resources
  • Resources

    • Release Notes
    • Platform Documentation
    • Our Integrations
    • Blog
  • Connect

    • Facebook
    • LinkedIn
    • Twitter
    • Contact Us
    • Privacy Policy