Getting started with the Athennian API

  • Updated

The Athennian API makes it easy to integrate your entity data into other applications or systems. Use this guide to get started sharing your data across systems.

 

Easy to access. Easy to modify.

The Athennian API is a GraphQL Internet protocol built around making semantically meaningful HTTPS requests to access or modify a resource (usually done by an employee). The API can be used to manipulate entity data and to generate reports in several formats.


GraphQL provides the flexibility to request exactly what is needed and nothing more. Construct a request by defining the resources you want via a POST request and receive a response that matches the format of your request.


GraphQL offers a more efficient, flexible integration. With GraphQL you can specify exactly what data you care about and retrieve as much or as little as needed, all through a single endpoint.

We make it easy for you to test API calls in our Sandbox environment.

 

What will you need to get started?

  • A software developer to write code
  • An HTTP client like Postman

If you are an Athennian customer:

  • An account with Athennian
  • An API key 


What does the Athennian API support?

Here’s a high-level view of everything v1 handles:

  • Fetch all the entities within your team,
  • Query to fetch specific entities within your team, and
  • Fetch only the fields within an entity that you want returned.

With an Athennian API Key, you will have administrator level access to your data across the team linked to the key.

 

Future plans

We will continue to expand the feature set of the Athennian API! If you’d like to be kept up to date on the API, or would like to start using it, reach out to your Customer Success Manager to get you connected. Check out our New Features section in the Help Center for a full list for recent updates and new capabilities in Athennian. If you’d like to request a feature, be sure to submit feedback.