Getting started with the Athennian API

Jordan Rindahl
Jordan Rindahl
  • 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.

 

What will you need to get started?

  • A software developer to write code
  • An HTTP client like Postman or Insomnia
  • API purchased within your Athennian subscription

What does the Athennian API support?

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

  • Fetch all the entities within Athennian
  • Fetch only the specific fields within an entity that you want

With an Athennian API Key, you will be granted access to specific entity profiles based on the configuration of Access Groups in Athennian. 

How do I configure the API?

  • Obtain your API Key in Athennian
    • Navigate to the Access Section > API Keys. If this section does not appear, contact your Customer Success Manager to enable this feature within your subscription. 
    • Click + New in the top right corner and name your API key

Screenshot 2023-10-17 at 11.48.05 AM.png

  • Open HTTP client interface
    • Screenshot 2023-10-17 at 12.04.18 PM.png
  • Set the API URL and Method
    • For a general sandbox environment, use XXX
    • For a live production environment, use api.athennian.com 
    • If you have purchased a separate sandbox environment, use the format client.api.test.athennian.com
    • Method used should be POST
  • Set the Headers & Authentication
    • Content-Type: application/json 
    • x-api-key: API key value
  • Setup the request
    • {entities {
      id
      status
      name
      entityType
      }}

 

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.