FAQs

Frequently asked questions 

What is the purpose of the Aspire External API reference?

The Aspire External API provides a conduit allowing two software systems to exchange data.

What type of API does Aspire support?

Aspire supports RESTful API using OData. REST is an acronym for Representational State Transfer. In this case, the "ful" indicates that other architectural blocks have been added instead of fully adhering to the principles of REST. In this case, the additional block is OData, a protocol under which the REST API operates. 

Where can I find documentation? 

You can still go directly to the Swagger. You can also directly access the documentation for each publically available endpoint and additional procedural information in this API guide. 

How can I access the External Aspire API?

Reach out to AspireCare if your company would like access to the API.

• Your current company tier determines how you can access the API:
  • Enterprise - API access is included.
  • Corporate Tier: API can be added for an additional $350/month, or sign up with an Aspire partner using the API.
  • Growth Tier: You must sign up with an Aspire partner.

How do I authenticate?
Click Authentication & Authorization for step-by-step instructions. 

Does Aspire partner with a company that can assist in building APIs? 

Yes. Aspire works with two third-party partners - Data Channel & Savvy Otter that have provided API solutions for clients. Reach out to your Customer Success or Implementation manager for more information.

Is there technical support provided?

In addition to documentation, we offer support in defining fields with your technical team. However, an extended support meeting will cost an additional $250/hour.