Skip to main content

Compology APIs

Overview of available APIs and links to documentation

Dana Beck avatar
Written by Dana Beck
Updated over 3 years ago

Containers API

The Compology Container API allows you to query data about your containers.

The API is based on REST principles, making it conform to industry-standard approaches, and making it easy to implement and test clients. You can use curl to test URLs and you can use any programming language to interact with the API.

Use cases of this API include (but are not limited to):

  • Getting a list of containers

  • Getting a list of containers for a specific customer

  • Getting a list of device posts for a specific container

  • Update a container's service schedule

  • Getting summarized collection data for a specific container

  • Getting rightsizing recommendations for a specific container

Full documentation can be found here.

Customers API

The Compology Customers and Locations Read/Write API allows you to query and create data about your customers and their service locations.

The API is based on REST principles, making it conform to industry-standard approaches, and making it easy to implement and test clients. You can use curl to test URLs and you can use any programming language to interact with the API.

Use cases of this API include (but are not limited to):

  • Getting a list of customers

  • Getting a list of service locations for a specific customer

  • Adding a service location

  • Deleting a service location

Full documentation can be found here.

Access

API access to the Compology data is available to all administrators. To start developing with Compology APIs you will need to obtain your API keys to authenticate your API requests.

Did this answer your question?