API Documentation
About the API
Our API serves as a powerful tool for integrating with external applications, facilitating seamless data transfer between systems like OneHQ and other applications. It utilizes GraphQL, which is an open-source query language and runtime. If you're new to GraphQL, learn more about at https://graphql.org/. Documentation for our GraphQL API is available at http://agencieshq.com/docs/graphql/index.html.
- To get started, you'll first need to find your API key at https://hqadmin.com/users/{your user id}/edit. Note that API keys are only accessible to users with access to the HQAdmin app. The production API key may only be used in production, while the staging API key must be used on every other environment.
- Once you have obtained your API key, you must use HTTP Bearer Authentication, as defined in RFC6750, to authenticate when sending requests to the API. We support Authorization Request Header as means to pass an API key.
- To help your developers get started, we've provided Postman samples at https://documenter.getpostman.com/view/13260626/TVmHFLg8 and have also built a small app at https://codesandbox.io/s/github/OneHQ/graphql-sandbox.