Getting Started

Getting Started with the Engagement GraphQL API

About the API

Much like the BaseCMS API the Engagement API can be accessed using GraphQL -- an abstract query language for retrieving data in a standard format, originally developed by the team at Facebook. GraphQL Playground can be used as a locally installed API client, or the GraphQL connection can be accessed programmatically in most languages with the use of a client. For more information about using GraphQL check out the docs.

You'll need the following information to read data from the API:

• An API URL

• A Tenant Key

If you're missing either of these, please reach out to [e-mail] and we'd be happy to help you out!

Connecting to the API

Your API URL will be in a format similar to that of the BaseCMS API however will be in the format like the following: engagement.<identifier>.base.parameter1.com. The API must be accessed via HTTP/S.

Requests to the GraphQL API must include the x-tenant-key header for the Base instance in question: such as x-tenant-key: my-base-instance-id. Once connected, you can see available query documentation and schema definitions within the GraphQL Playground application (if using it). For information regarding the available queries and the data they return see the Querying Data topic. For further information regarding Connecting to the API consult the Overview section of BaseCMS GraphQL API documentation.