Search

API Basics

Andrew Anderson
Andrew Anderson
  • Updated

Welcome

Welcome to the Athennian API experience! Here we'll guide you through each step of the journey.

Prefer learning more with your Microsoft Copilot or other AI assistant? No problem! ▶️ Here you'll find a quick video demo with examples of how this can be done for most of our automation solutions, and more here. 

For a simplified list of all API resources, click here. You may find helpful our video demos of API integration here and API access setup here.

Introduction

The Athennian API allows your teams the ability to scale by engineering integration automation and tailored customization between Athennian accounts as well as most other applications.

Before proceeding, please check our list of integrations here to see if the functionality you want has already been built.

Please contact us directly for a personalized introduction!

Product Scope:

Below is a general overview of what our API provides today. For details, please see our technical documentation below, and/or contact us.

If you need or want any additional API functionality, please let us know! We might be able to quickly accommodate you in a variety of ways.

Category Asset Supported
Product

Most primary Athennian data and functionality (read and write) for each collection below via API:

-  Entity (custom fields mostly), People (no custom fields), Addresses, Registrations, Affiliations, Securities (only Classes, Shareholdings, Issuance Transactions), Documents / Files, etc.

 Yes ✅
Product

Secondary Athennian data and functionality via API:

- Tasks, Templates, Access (other than access groups), etc.

 No ❌
Technology

GraphQL API w/ some RESTful

 Yes ✅
Technology

- Reference Schema Introspection (for security reasons)

- Webhooks (event-based triggers)

 No ❌

Additional Introductions:

Technical Documentation:

 

As a brief example, through our API, you could pull 100 entity names and IDs by configuring the query below in an app like Postman:

API Request:

query {
 entities(
  options: {limit:100, skip:0})
  {name, id}
}

API Response:

{ "data": {
 "entities": [
  {"name": "Entity A",
   "id": "663c47fb1cb8a360640a417b"},
  {"name": "Entity B",
   "id": "663c4822746d0760cf6b1f4c"}
 ]
}}

Setup

In this article, we will guide you through how to setup the API feature.

FAQ

  • How do I learn more about the API?
    • Please contact us so we can start your Athennian API journey.
  • What does an API do for my business?
    • Our API gives your teams the ability to scale by building high levels of integration automation and tailored customization. This decreases costly busy work, and empowers your teams to do the strategic work they prefer.
  • How would we use the API?
    • Your team would use it to programmatically build custom integrations between any of your tools including Athennian. For example, you could automate the creation, maintenance, and reporting of entity data without any of the usual, manual work.
  • Can I see an example of the API working?
    • Yes, please contact us or click here.
  • What can your API do?
    • Ours is primarily a GraphQL API which can read and write core Athennian data including entities, people, addresses, registrations, affiliations, and securities.
  • What is your API SLA?
    • API covered by our same regular SLA here. You can also review our uptime on our Status page here.
  • How secure is your API?
    • API is covered by our regular security measures documented here.

😃 Thank you for visiting! Please let us know if you have any feedback regarding this information.